time-to-botec

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

repl.txt (2399B)

      1 
      2 {{alias}}( N, x, stride )
      3     Computes the L2-norm of a double-precision floating-point vector.
      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` or `stride <= 0`, the function returns `0.0`.
     12 
     13     Parameters
     14     ----------
     15     N: integer
     16         Number of indexed elements.
     17 
     18     x: Float64Array
     19         Input array.
     20 
     21     stride: integer
     22         Index increment.
     23 
     24     Returns
     25     -------
     26     nrm2: number
     27         The L2-norm.
     28 
     29     Examples
     30     --------
     31     // Standard Usage:
     32     > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 2.0 ] );
     33     > {{alias}}( x.length, x, 1 )
     34     3.0
     35 
     36     // Using `N` and `stride` parameters:
     37     > x = new {{alias:@stdlib/array/float64}}( [ -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     3.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     3.0
     50 
     51 {{alias}}.ndarray( N, x, stride, offset )
     52     Computes the L2-norm of a double-precision floating-point vector using
     53     alternative indexing semantics.
     54 
     55     While typed array views mandate a view offset based on the underlying
     56     buffer, the `offset` parameter supports indexing semantics based on a
     57     starting index.
     58 
     59     Parameters
     60     ----------
     61     N: integer
     62         Number of indexed elements.
     63 
     64     x: Float64Array
     65         Input array.
     66 
     67     stride: integer
     68         Index increment.
     69 
     70     offset: integer
     71         Starting index.
     72 
     73     Returns
     74     -------
     75     nrm2: number
     76         The L2-norm.
     77 
     78     Examples
     79     --------
     80     // Standard Usage:
     81     > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 2.0 ] );
     82     > {{alias}}.ndarray( x.length, x, 1, 0 )
     83     3.0
     84 
     85     // Using offset parameter:
     86     > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
     87     > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
     88     > {{alias}}.ndarray( N, x, 2, 1 )
     89     3.0
     90 
     91     See Also
     92     --------
     93