stdlib/lib/node_modules/@stdlib/strided/base/zmap/docs/repl.txt at b46726fdcc80c36dff56e34bed0ff355e1482948 · prajjwalbajpai/stdlib · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

{{alias}}( N, x, strideX, y, strideY, fcn )
    Applies a unary function to a double-precision complex floating-point
    strided input array and assigns results to a double-precision complex
    floating-point strided output array.

    The `N` and stride parameters determine which elements in the strided arrays
    are accessed at runtime.

    Indexing is relative to the first index. To introduce an offset, use typed
    array views.

    Parameters
    ----------
    N: integer
        Number of indexed elements.

    x: Complex128Array
        Input array.

    strideX: integer
        Index increment for `x`.

    y: Complex128Array
        Destination array.

    strideY: integer
        Index increment for `y`.

    fcn: Function
        Unary function to apply.

    Returns
    -------
    y: Complex128Array
        Input array `y`.

    Examples
    --------
    // Standard usage:
    > var xbuf = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ];
    > var x = new {{alias:@stdlib/array/complex128}}( xbuf );
    > var y = new {{alias:@stdlib/array/complex128}}( x.length );
    > {{alias}}( x.length, x, 1, y, 1, {{alias:@stdlib/complex/float64/base/identity}} );
    > var v = y.get( 0 )
    <Complex128>[ 1.0, 2.0 ]

    // Using `N` and stride parameters:
    > y = new {{alias:@stdlib/array/complex128}}( x.length );
    > {{alias}}( 2, x, 2, y, -1, {{alias:@stdlib/complex/float64/base/identity}} );
    > v = y.get( 0 )
    <Complex128>[ 5.0, 6.0 ]

    // Using view offsets:
    > var x0 = new {{alias:@stdlib/array/complex128}}( xbuf );
    > var y0 = new {{alias:@stdlib/array/complex128}}( x0.length );
    > var x1 = new {{alias:@stdlib/array/complex128}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
    > var y1 = new {{alias:@stdlib/array/complex128}}( y0.buffer, y0.BYTES_PER_ELEMENT*2 );
    > {{alias}}( 2, x1, -2, y1, 1, {{alias:@stdlib/complex/float64/base/identity}} );
    > v = y1.get( 0 )
    <Complex128>[ 7.0, 8.0 ]


{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY, fcn )
    Applies a unary function to a double-precision complex floating-point
    strided input array and assigns results to a double-precision complex
    floating-point strided output array using alternative indexing semantics.

    While typed array views mandate a view offset based on the underlying
    buffer, the offset parameters support indexing semantics based on starting
    indices.

    Parameters
    ----------
    N: integer
        Number of indexed elements.

    x: Complex128Array
        Input array.

    strideX: integer
        Index increment for `x`.

    offsetX: integer
        Starting index for `x`.

    y: Complex128Array
        Destination array.

    strideY: integer
        Index increment for `y`.

    offsetY: integer
        Starting index for `y`.

    fcn: Function
        Unary function to apply.

    Returns
    -------
    y: Complex128Array
        Input array `y`.

    Examples
    --------
    // Standard usage:
    > var xbuf = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ];
    > var x = new {{alias:@stdlib/array/complex128}}( xbuf );
    > var y = new {{alias:@stdlib/array/complex128}}( x.length );
    > {{alias}}.ndarray( x.length, x, 1, 0, y, 1, 0, {{alias:@stdlib/complex/float64/base/identity}} );
    > var v = y.get( 0 )
    <Complex128>[ 1.0, 2.0 ]

    // Advanced indexing:
    > x = new {{alias:@stdlib/array/complex128}}( xbuf );
    > y = new {{alias:@stdlib/array/complex128}}( x.length );
    > {{alias}}.ndarray( 2, x, 2, 1, y, -1, y.length-1, {{alias:@stdlib/complex/float64/base/identity}} );
    > v = y.get( y.length-1 )
    <Complex128>[ 3.0, 4.0 ]

    See Also
    --------