time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

repl.txt (2690B)


      1 
      2 {{alias}}( N, x, stride )
      3     Computes the arithmetic mean of a single-precision floating-point strided
      4     array using a two-pass error correction algorithm with extended accumulation
      5     and returning an extended precision result.
      6 
      7     The `N` and `stride` parameters determine which elements in `x` are accessed
      8     at runtime.
      9 
     10     Indexing is relative to the first index. To introduce an offset, use a typed
     11     array view.
     12 
     13     If `N <= 0`, the function returns `NaN`.
     14 
     15     Parameters
     16     ----------
     17     N: integer
     18         Number of indexed elements.
     19 
     20     x: Float32Array
     21         Input array.
     22 
     23     stride: integer
     24         Index increment.
     25 
     26     Returns
     27     -------
     28     out: number
     29         The arithmetic mean.
     30 
     31     Examples
     32     --------
     33     // Standard Usage:
     34     > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 2.0 ] );
     35     > {{alias}}( x.length, x, 1 )
     36     ~0.3333
     37 
     38     // Using `N` and `stride` parameters:
     39     > x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] );
     40     > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
     41     > var stride = 2;
     42     > {{alias}}( N, x, stride )
     43     ~0.3333
     44 
     45     // Using view offsets:
     46     > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
     47     > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
     48     > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
     49     > stride = 2;
     50     > {{alias}}( N, x1, stride )
     51     ~-0.3333
     52 
     53 {{alias}}.ndarray( N, x, stride, offset )
     54     Computes the arithmetic mean of a single-precision floating-point strided
     55     array using a two-pass error correction algorithm with extended accumulation
     56     and alternative indexing semantics and returning an extended precision
     57     result.
     58 
     59     While typed array views mandate a view offset based on the underlying
     60     buffer, the `offset` parameter supports indexing semantics based on a
     61     starting index.
     62 
     63     Parameters
     64     ----------
     65     N: integer
     66         Number of indexed elements.
     67 
     68     x: Float32Array
     69         Input array.
     70 
     71     stride: integer
     72         Index increment.
     73 
     74     offset: integer
     75         Starting index.
     76 
     77     Returns
     78     -------
     79     out: number
     80         The arithmetic mean.
     81 
     82     Examples
     83     --------
     84     // Standard Usage:
     85     > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 2.0 ] );
     86     > {{alias}}.ndarray( x.length, x, 1, 0 )
     87     ~0.3333
     88 
     89     // Using offset parameter:
     90     > var x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
     91     > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
     92     > {{alias}}.ndarray( N, x, 2, 1 )
     93     ~-0.3333
     94 
     95     See Also
     96     --------
     97