time-to-botec

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

repl.txt (2354B)

      1 
      2 {{alias}}( N, alpha, x, stride )
      3     Adds a constant to each strided array element and computes the sum.
      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 `0.0`.
     12 
     13     Parameters
     14     ----------
     15     N: integer
     16         Number of indexed elements.
     17 
     18     alpha: number
     19         Constant.
     20 
     21     x: Array<number>|TypedArray
     22         Input array.
     23 
     24     stride: integer
     25         Index increment.
     26 
     27     Returns
     28     -------
     29     out: number
     30         Sum.
     31 
     32     Examples
     33     --------
     34     // Standard Usage:
     35     > var x = [ 1.0, -2.0, 2.0 ];
     36     > {{alias}}( x.length, 5.0, x, 1 )
     37     16.0
     38 
     39     // Using `N` and `stride` parameters:
     40     > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];
     41     > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
     42     > var stride = 2;
     43     > {{alias}}( N, 5.0, x, stride )
     44     16.0
     45 
     46     // Using view offsets:
     47     > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
     48     > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
     49     > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
     50     > stride = 2;
     51     > {{alias}}( N, 5.0, x1, stride )
     52     14.0
     53 
     54 {{alias}}.ndarray( N, alpha, x, stride, offset )
     55     Adds a constant to each strided array element and computes the sum using
     56     alternative indexing semantics.
     57 
     58     While typed array views mandate a view offset based on the underlying
     59     buffer, the `offset` parameter supports indexing semantics based on a
     60     starting index.
     61 
     62     Parameters
     63     ----------
     64     N: integer
     65         Number of indexed elements.
     66 
     67     alpha: number
     68         Constant.
     69 
     70     x: Array<number>|TypedArray
     71         Input array.
     72 
     73     stride: integer
     74         Index increment.
     75 
     76     offset: integer
     77         Starting index.
     78 
     79     Returns
     80     -------
     81     out: number
     82         Sum.
     83 
     84     Examples
     85     --------
     86     // Standard Usage:
     87     > var x = [ 1.0, -2.0, 2.0 ];
     88     > {{alias}}.ndarray( x.length, 5.0, x, 1, 0 )
     89     16.0
     90 
     91     // Using offset parameter:
     92     > var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ];
     93     > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
     94     > {{alias}}.ndarray( N, 5.0, x, 2, 1 )
     95     14.0
     96 
     97     See Also
     98     --------
     99