time-to-botec

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

repl.txt (2827B)

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