File: repl.txt

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (40 lines) | stat: -rw-r--r-- 1,010 bytes parent folder | download
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

{{alias}}( x, y )
    Computes the dot product of two vectors.

    In general, for best performance, especially for large vectors, provide
    1-dimensional ndarrays whose underlying data type is either 'float64' or
    'float32'.

    If provided empty vectors, the function returns `0.0`.

    Parameters
    ----------
    x: ndarray|ArrayLikeObject
        First input array.

    y: ndarray|ArrayLikeObject
        Second input array.

    Returns
    -------
    dot: number
        The dot product.

    Examples
    --------
    // Using ndarrays...
    > var x = {{alias:@stdlib/ndarray/array}}( new {{alias:@stdlib/array/float64}}( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ) );
    > var y = {{alias:@stdlib/ndarray/array}}( new {{alias:@stdlib/array/float64}}( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
    > {{alias}}( x, y )
    -5.0

    // Using array-like objects...
    > x = [ 4.0, 2.0, -3.0, 5.0, -1.0 ];
    > y = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
    > {{alias}}( x, y )
    -5.0

    See Also
    --------