time-to-botec

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

repl.txt (2178B)

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