JSDoc: Global

Members

(constant) random :Generator

Type:

Generator

Source:

random.Generator.mjs, line 246

Methods

allclose(a, b, rtolopt, atolopt, equal_nanopt) → {boolean}

Parameters:

Name	Type	Attributes	Default
`a`	NDArray
`b`	NDArray
`rtol`	number	<optional>	1e-5
`atol`	number	<optional>	1e-8
`equal_nan`	boolean	<optional>	false

Source:

isclose.mjs, line 80

Returns:

Type: boolean

arange(start, stopopt, stepopt) → {NDArray}

The parameters can be either float or integer numbers.

Parameters:

Name	Type	Attributes
`start`	number
`stop`	number	<optional>
`step`	number	<optional>

Source:

arange.mjs, line 16

Returns:

Type: NDArray

Examples

arange(2) // array([0, 1])

arange(1, 3) // array([1, 2])

arange(0, 6, 2) // array([0, 2, 4])

argmax(a, axisopt, outopt, keepdimsopt) → {NDArray}

Parameters:

Name	Type	Attributes	Default	Description
`a`	NDArray			array-like
`axis`	number \| null	<optional>	null
`out`	NDArray \| null	<optional>	null
`keepdims`	boolean	<optional>	false

Source:

argmax.mjs, line 20

Returns:

Type: NDArray

argmin(a, axisopt, outopt, keepdimsopt) → {NDArray}

Parameters:

Name	Type	Attributes	Default	Description
`a`	NDArray			array-like
`axis`	number \| null	<optional>	null
`out`	NDArray \| null	<optional>	null
`keepdims`	boolean	<optional>	false

Source:

argmax.mjs, line 87

Returns:

Type: NDArray

argsort(a, axis, key) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray
`axis`	number
`key`	function

Source:

argsort.mjs, line 18

Returns:

Type: NDArray

argwhere(a) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray

Source:

argwhere.mjs, line 18

Returns:

Type: NDArray

array(a, dtypeopt, copyopt, ndminopt) → {NDArray}

Parameters:

Name	Type	Attributes	Default	Description
`a`	NDArray			array-like
`dtype`	Dtype	<optional>
`copy`	boolean	<optional>	true
`ndmin`	number	<optional>	0

Source:

array.mjs, line 10

Returns:

Type: NDArray

array2string(a, options) → {string}

Parameters:

Name	Type	Description
`a`	NDArray
`options`	FormatOptions

Source:

array2string.mjs, line 21

Returns:

Type: string

array_equal(a1, a2, equal_nanopt) → {boolean}

Parameters:

Name	Type	Attributes	Description
`a1`	NDArray		array-like
`a2`	NDArray		array-like
`equal_nan`	boolean	<optional>

Source:

array_equal.mjs, line 9

Returns:

Type: boolean

array_equiv(a1, a2) → {boolean}

Parameters:

Name	Type	Description
`a1`	NDArray	array-like
`a2`	NDArray	array-like

Source:

array_equal.mjs, line 26

Returns:

Type: boolean

array_repr(a, linewidth, precision) → {string}

Parameters:

Name	Type	Description
`a`	NDArray
`linewidth`	number
`precision`	number

Source:

array2string.mjs, line 54

Returns:

Type: string

array_split(a, indices_or_sections, axisopt) → {NDArray}

Parameters:

Name	Type	Attributes
`a`	NDArray
`indices_or_sections`	number \| Array.<number>
`axis`	number	<optional>

Source:

array_split.mjs, line 9

Returns:

Type: NDArray

array_str(a, linewidth, precision) → {string}

Parameters:

Name	Type	Description
`a`	NDArray
`linewidth`	number
`precision`	number

Source:

array2string.mjs, line 38

Returns:

Type: string

asarray(a, dtypeopt) → {NDArray}

Parameters:

Name	Type	Attributes	Description
`a`	NDArray		array-like
`dtype`	Dtype	<optional>

Source:

asarray.mjs, line 8

Returns:

Type: NDArray

ascontiguousarray(a, dtypeopt) → {NDArray}

Parameters:

Name	Type	Attributes	Description
`a`	NDArray		array-like
`dtype`	Dtype	<optional>

Source:

ascontiguousarray.mjs, line 8

Returns:

Type: NDArray

atleast_1d(…arrays) → {NDArray|Array.<NDArray>}

Returns a NDArray if only one argument is passed, otherwise returns an array of NDArrays

Parameters:

Name	Type	Attributes	Description
`arrays`	NDArray	<repeatable>

Source:

atleast.mjs, line 12

Returns:

Type: NDArray | Array.<NDArray>

Examples

atleast_1d(1.0) // array([1])

atleast_1d(1, [3, 4]) // [array([1]), array([3, 4])]

atleast_2d(…arrays) → {NDArray|Array.<NDArray>}

Returns a NDArray if only one argument is passed, otherwise returns an array of NDArrays

Parameters:

Name	Type	Attributes	Description
`arrays`	NDArray	<repeatable>

Source:

atleast.mjs, line 34

Returns:

Type: NDArray | Array.<NDArray>

Examples

atleast_2d(1.0) // array([[1]])

atleast_2d(1, [3, 4]) // [array([[1]]), array([[3, 4]])]

atleast_3d(…arrays) → {NDArray|Array.<NDArray>}

Returns a NDArray if only one argument is passed, otherwise returns an array of NDArrays

Parameters:

Name	Type	Attributes	Description
`arrays`	NDArray	<repeatable>

Source:

atleast.mjs, line 58

Returns:

Type: NDArray | Array.<NDArray>

Examples

atleast_3d(1.0) // array([[[1]]])

atleast_3d(1, [3, 4]) // [array([[[1]]]), array([[[3], [4]]])]

average(a, axis, weights, returned, keepdims) → {NDArray}

Parameters:

Name	Type	Description
`a`	*
`axis`	*
`weights`	*
`returned`	*
`keepdims`	*

Source:

statistics.mjs, line 62

Returns:

Type: NDArray

bincount(a, weights, minlength) → {NDArray}

Parameters:

Name	Type	Description
`a`	*
`weights`	*
`minlength`	*

Source:

statistics.mjs, line 166

Returns:

Type: NDArray

broadcast(…arrays) → {Broadcast}

Parameters:

Name	Type	Attributes	Description
`arrays`	NDArray	<repeatable>

Source:

broadcast.mjs, line 7

Returns:

Type: Broadcast

broadcast_arrays(…arrays) → {Array.<NDArray>}

Parameters:

Name	Type	Attributes	Description
`arrays`	NDArray	<repeatable>

Source:

broadcast_to.mjs, line 31

Returns:

Type: Array.<NDArray>

broadcast_shapes(…shapes) → {Array.<number>}

Parameters:

Name	Type	Attributes	Description
`shapes`	Array.<number>	<repeatable>

Source:

broadcast_shapes.mjs, line 7

Returns:

Type: Array.<number>

broadcast_to(a, shape) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray	array-like
`shape`	Array.<number>

Source:

broadcast_to.mjs, line 8

Returns:

Type: NDArray

clip(a, a_min, a_max, out) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray	array-like
`a_min`	NDArray	array-like
`a_max`	NDArray	array-like
`out`	NDArray

Source:

clip.mjs, line 21

Returns:

Type: NDArray

column_stack(arrs) → {NDArray}

Parameters:

Name	Type	Description
`arrs`	Array.<NDArray>

Source:

column_stack.mjs, line 7

Returns:

Type: NDArray

compress(condition, a, axisopt, outopt) → {NDArray}

Parameters:

Name	Type	Attributes
`condition`	Array.<boolean>
`a`	NDArray
`axis`	number	<optional>
`out`	NDArray	<optional>

Source:

compress.mjs, line 10

Returns:

Type: NDArray

concatenate(arrays, axisopt, outopt) → {NDArray}

Parameters:

Name	Type	Attributes
`arrays`	Array.<NDArray>
`axis`	null \| number	<optional>
`out`	NDArray	<optional>

Source:

concatenate.mjs, line 19

Returns:

Type: NDArray

convolve(a, v, modeopt) → {NDArray}

Parameters:

Name	Type	Attributes
`a`	NDArray
`v`	NDArray
`mode`	string	<optional>

Source:

convolve.mjs, line 9

Returns:

Type: NDArray

copy(a) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray	array-like

Source:

copy.mjs, line 7

Returns:

Type: NDArray

copyto(dst, src) → {void}

Parameters:

Name	Type	Description
`dst`	NDArray
`src`	NDArray	array-like

Source:

copyto.mjs, line 8

Returns:

Type: void

count_nonzero(a, axisopt, keepdimsopt) → {NDArray}

Parameters:

Name	Type	Attributes
`a`	NDArray
`axis`	null \| number \| Array.<number>	<optional>
`keepdims`	boolean	<optional>

Source:

count_nonzero.mjs, line 10

Returns:

Type: NDArray

cross(a, b, axisopt, axisaopt, axisbopt, axiscopt) → {NDArray}

Parameters:

Name	Type	Attributes
`a`	NDArray
`b`	NDArray
`axis`	number	<optional>
`axisa`	number	<optional>
`axisb`	number	<optional>
`axisc`	number	<optional>

Source:

cross.mjs, line 24

Returns:

Type: NDArray

cumprod(x, axisopt, outopt) → {NDArray}

x1 * x2

Parameters:

Name	Type	Attributes	Default
`x`	NDArray
`axis`	null \| number \| Array.<number>	<optional>	null
`out`	null \| NDArray	<optional>	null

Source:

cumulative.mjs, line 11

Returns:

Type: NDArray

cumsum(x, axisopt, outopt) → {NDArray}

x1 + x2

Parameters:

Name	Type	Attributes	Default
`x`	NDArray
`axis`	null \| number \| Array.<number>	<optional>	null
`out`	null \| NDArray	<optional>	null

Source:

cumulative.mjs, line 21

Returns:

Type: NDArray

diag(v, kopt) → {NDArray}

Parameters:

Name	Type	Attributes	Description
`v`	NDArray
`k`	number	<optional>

Source:

diag.mjs, line 8

Returns:

Type: NDArray

diagonal(a, offsetopt, axis1opt, axis2opt) → {NDArray}

Parameters:

Name	Type	Attributes
`a`	NDArray
`offset`	number	<optional>
`axis1`	number	<optional>
`axis2`	number	<optional>

Source:

diagonal.mjs, line 10

Returns:

Type: NDArray

dot(a, b, outopt) → {NDArray}

Parameters:

Name	Type	Attributes
`a`	NDArray
`b`	NDArray
`out`	null \| NDArray	<optional>

Source:

dot.mjs, line 33

Returns:

Type: NDArray

dstack(arrays) → {NDArray}

Parameters:

Name	Type	Description
`arrays`	Array.<NDArray>

Source:

dstack.mjs, line 7

Returns:

Type: NDArray

dtype(dtype, array, name) → {Dtype}

Parameters:

Name	Type	Description
`dtype`	Dtype \| string \| function
`array`	function
`name`	string

Source:

dtype.mjs, line 97

Returns:

Type: Dtype

Examples

dtype('number') == dtype(Number) // by string or value type function

dtype('int8') == dtype(Int8Array) // by string or TypedArray constructor

dtype('object') == dtype(Array) // default type and container

dtype(dtype('object')) == dtype('object') // wraps dtype

dtype() or dtype(null) // throws an error

empty(shape, dtypeopt) → {NDArray}

empty(2) is equivalent to empty([2])

Parameters:

Name	Type	Attributes	Description
`shape`	number \| Array.<number>		empty([]) for a scalar ndarray
`dtype`	Dtype	<optional>

Source:

empty.mjs, line 9

Returns:

Type: NDArray

empty_like(a, dtypeopt) → {NDArray}

Parameters:

Name	Type	Attributes	Description
`a`	NDArray		array-like
`dtype`	Dtype	<optional>

Source:

empty.mjs, line 20

Returns:

Type: NDArray

expand_dims(a, axis) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray
`axis`	number \| Array.<number>

Source:

expand_dims.mjs, line 8

Returns:

Type: NDArray

extract(condition, a) → {NDArray}

Parameters:

Name	Type	Description
`condition`	NDArray
`a`	NDArray

Source:

extract.mjs, line 9

Returns:

Type: NDArray

eye(N, Mopt, kopt, dtypeopt) → {NDArray}

Parameters:

Name	Type	Attributes
`N`	NDArray
`M`	number	<optional>
`k`	number	<optional>
`dtype`	Dtype	<optional>

Source:

eye.mjs, line 10

Returns:

Type: NDArray

flatnonzero(a) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray

Source:

flatnonzero.mjs, line 7

Returns:

Type: NDArray

flip(a, axisopt) → {NDArray}

Parameters:

Name	Type	Attributes	Description
`a`	NDArray
`axis`	null \| number \| Array.<number>	<optional>

Source:

flip.mjs, line 21

Returns:

Type: NDArray

fliplr(a) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray

Source:

flip.mjs, line 40

Returns:

Type: NDArray

flipud(a) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray

Source:

flip.mjs, line 50

Returns:

Type: NDArray

fromfunction(func, shape, dtypeopt) → {NDArray}

Parameters:

Name	Type	Attributes
`func`	function
`shape`	Array.<number>
`dtype`	Dtype	<optional>

Source:

fromfunction.mjs, line 9

Returns:

Type: NDArray

fromiter(iter, countopt, dtypeopt) → {NDArray}

Parameters:

Name	Type	Attributes
`iter`	Iterable
`count`	number	<optional>
`dtype`	Dtype	<optional>

Source:

fromiter.mjs, line 9

Returns:

Type: NDArray

full(shape, fill_value, dtypeopt) → {NDArray}

Parameters:

Name	Type	Attributes
`shape`	Array.<number>
`fill_value`	any
`dtype`	Dtype	<optional>

Source:

full.mjs, line 9

Returns:

Type: NDArray

full_like(a, fill_value, dtypeopt) → {NDArray}

Parameters:

Name	Type	Attributes	Description
`a`	NDArray		array-like
`fill_value`	any
`dtype`	Dtype	<optional>

Source:

full.mjs, line 21

Returns:

Type: NDArray

get(a, indices) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray	array-like
`indices`	Array.<(number\|Slice\|string\|null\|Array.<number>\|Array.<boolean>\|NDArray)>

Source:

scatter.mjs, line 189

Returns:

Type: NDArray

hstack(arrays) → {NDArray}

Parameters:

Name	Type	Description
`arrays`	Array.<NDArray>

Source:

hstack.mjs, line 7

Returns:

Type: NDArray

identity(n, dtypeopt) → {NDArray}

Parameters:

Name	Type	Attributes	Description
`n`	number
`dtype`	Dtype	<optional>

Source:

identity.mjs, line 8

Returns:

Type: NDArray

index_exp(args) → {Array.<(null|number|Slice|string)>}

Parameters:

Name	Type	Description
`args`	null \| number \| Slice \| string

Source:

s_.mjs, line 15

Returns:

Type: Array.<(null|number|Slice|string)>

indices(dimensions, sparseopt) → {NDArray}

Parameters:

Name	Type	Attributes	Description
`dimensions`	Array.<number>
`sparse`	boolean	<optional>

Source:

indices.mjs, line 8

Returns:

Type: NDArray

interp(x, xp, fp, leftopt, rightopt, periodopt) → {NDArray}

Parameters:

Name	Type	Attributes
`x`	NDArray
`xp`	NDArray
`fp`	NDArray
`left`	null \| number	<optional>
`right`	null \| number	<optional>
`period`	null \| number	<optional>

Source:

interp.mjs, line 12

Returns:

Type: NDArray

isclose(a, b, rtolopt, atolopt, equal_nanopt) → {NDArray}

Parameters:

Name	Type	Attributes	Default
`a`	NDArray
`b`	NDArray
`rtol`	number	<optional>	1e-5
`atol`	number	<optional>	1e-8
`equal_nan`	boolean	<optional>	false

Source:

isclose.mjs, line 28

Returns:

Type: NDArray

isscalar(element) → {boolean}

Parameters:

Name	Type	Description
`element`	any

Source:

isscalar.mjs, line 7

Returns:

Type: boolean

ix_(args) → {Array.<NDArray>}

Parameters:

Name	Type	Description
`args`	...Array.<number> \| Array.<boolean>

Source:

ix_.mjs, line 7

Returns:

Type: Array.<NDArray>

linspace(start, stop, numopt, endpointopt, retstepopt) → {NDArray}

Parameters:

Name	Type	Attributes
`start`	number
`stop`	number
`num`	number	<optional>
`endpoint`	boolean	<optional>
`retstep`	boolean	<optional>

Source:

linspace.mjs, line 11

Returns:

Type: NDArray

lu(a) → {Array.<Array.<Array.<number>>>}

Parameters:

Name	Type	Description
`a`	Array.<Array.<number>>

Source:

linalg.mjs, line 31

Returns:

Type: Array.<Array.<Array.<number>>>

lu_factor(a) → {Array.<Array.<Array.<number>>, Array.<number>>}

Parameters:

Name	Type	Description
`a`	Array.<Array.<number>>	(M, N) array

Source:

linalg.mjs, line 88

Returns:

Type: Array.<Array.<Array.<number>>, Array.<number>>

lu_factor_(a, M, N) → {Array.<Array.<Array.<number>>, Array.<number>>}

Parameters:

Name	Type	Description
`a`	Array.<Array.<number>>	(M, N) array
`M`	number
`N`	number

Source:

linalg.mjs, line 133

Returns:

Type: Array.<Array.<Array.<number>>, Array.<number>>

lu_solve(lu_piv, b) → {Array.<number>}

Parameters:

Name	Type	Description
`lu_piv`	Array.<Array.<Array.<number>>, Array.<number>>
`b`	Array.<number>

Source:

linalg.mjs, line 177

Returns:

Type: Array.<number>

map(ndarray, callback) → {NDArray}

Parameters:

Name	Type	Description
`ndarray`	NDArray
`callback`	function

Source:

map.mjs, line 130

Returns:

Type: NDArray

matmul(x1, x2, outopt) → {NDArray}

Parameters:

Name	Type	Attributes
`x1`	NDArray
`x2`	NDArray
`out`	NDArray	<optional>

Source:

matmul.mjs, line 23

Returns:

Type: NDArray

mean(a, axis, out, keepdims) → {NDArray}

Parameters:

Name	Type	Description
`a`	*
`axis`	*
`out`	*
`keepdims`	*

Source:

statistics.mjs, line 99

Returns:

Type: NDArray

moveaxis(a, src, dst) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray
`src`	number \| Array.<number>
`dst`	number \| Array.<number>

Source:

moveaxis.mjs, line 9

Returns:

Type: NDArray

nancumprod(x, axisopt, outopt) → {NDArray}

nan1(x1) * nan1(x2)

Parameters:

Name	Type	Attributes	Default
`x`	NDArray
`axis`	null \| number \| Array.<number>	<optional>	null
`out`	null \| NDArray	<optional>	null

Source:

cumulative.mjs, line 33

Returns:

Type: NDArray

nancumsum(x, axisopt, outopt) → {NDArray}

nan0(x1) + nan0(x2)

Parameters:

Name	Type	Attributes	Default
`x`	NDArray
`axis`	null \| number \| Array.<number>	<optional>	null
`out`	null \| NDArray	<optional>	null

Source:

cumulative.mjs, line 45

Returns:

Type: NDArray

ndenumerate(a) → {NdenumerateIterator}

Parameters:

Name	Type	Description
`a`	NDArray

Source:

ndenumerate.mjs, line 7

Returns:

Type: NdenumerateIterator

ndim(a) → {number}

Return the ndim of an array without invoking array creation.

Parameters:

Name	Type	Description
`a`	any

Source:

ndim.mjs, line 8

Returns:

Type: number

ndindex(shape) → {NdindexIterator}

Parameters:

Name	Type	Description
`shape`	Array.<number>

Source:

ndindex.mjs, line 7

Returns:

Type: NdindexIterator

nditer(a, axis) → {Nditer}

Parameters:

Name	Type	Description
`a`	NDArray
`axis`	null \| number \| Array.<number>

Source:

numeric.mjs, line 65

Returns:

Type: Nditer

ndoffset(shape, strides, initialopt) → {NdoffsetIterator}

Parameters:

Name	Type	Attributes	Default
`shape`	Array.<number>
`strides`	Array.<number>
`initial`	number	<optional>	0

Source:

ndoffset.mjs, line 97

Returns:

Type: NdoffsetIterator

nonzero(a) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray

Source:

nonzero.mjs, line 7

Returns:

Type: NDArray

ogrid(…slices) → {NDArray}

Parameters:

Name	Type	Attributes	Description
`slices`	Slice	<repeatable>

Source:

ogrid.mjs, line 7

Returns:

Type: NDArray

ones(shape, dtypeopt) → {NDArray}

Parameters:

Name	Type	Attributes	Description
`shape`	Array.<number>
`dtype`	Dtype	<optional>

Source:

ones.mjs, line 8

Returns:

Type: NDArray

ones_like(a, dtypeopt) → {NDArray}

Parameters:

Name	Type	Attributes	Description
`a`	NDArray		array-like
`dtype`	Dtype	<optional>

Source:

ones.mjs, line 17

Returns:

Type: NDArray

pick(size, popt, replaceopt, methodopt, dataopt, randopt) → {Array.<any>}

Parameters:

Name	Type	Attributes
`size`	number
`p`	null \| Array.<number>	<optional>
`replace`	boolean	<optional>
`method`	string	<optional>
`data`	Array.<any>	<optional>
`rand`	function	<optional>

Source:

random.pick.mjs, line 137

Returns:

Type: Array.<any>

ptp(a, axis, out, keepdims) → {NDArray}

Parameters:

Name	Type	Description
`a`	*
`axis`	*
`out`	*
`keepdims`	*

Source:

statistics.mjs, line 35

Returns:

Type: NDArray

put(a, ind, v, modeopt)

Parameters:

Name	Type	Attributes	Description
`a`	NDArray		array-like
`ind`	number \| Array.<number>
`v`	Array.<any>
`mode`	string	<optional>

Source:

put.mjs, line 20

ravel(a) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray

Source:

ravel.mjs, line 7

Returns:

Type: NDArray

ravel_multi_index(multi_index, shape, modeopt)

One mode per index is not supported yet

Parameters:

Name	Type	Attributes	Description
`multi_index`	Array.<NDArray>		array-like array
`shape`	Array.<number>
`mode`	string	<optional>	{'raise', 'wrap', 'clip'}

Source:

ravel_multi_index.mjs, line 35

Examples

ravel_multi_index([[3, 6, 6], [4, 5, 1]], [4, 6], 'clip')
// array([22, 23, 19])

ravel_multi_index([3, 1, 4, 1], [6, 7, 8, 9])
// array(1621)

reduce(a, callback) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray
`callback`	reduceCallback

Source:

map.mjs, line 140

Returns:

Type: NDArray

repeat(a, repeats, axisopt) → {NDArray}

Parameters:

Name	Type	Attributes
`a`	NDArray
`repeats`	number
`axis`	null \| number	<optional>

Source:

repeat.mjs, line 26

Returns:

Type: NDArray

reshape(a, newshape) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray	array-like
`newshape`	Array.<number>

Source:

reshape.mjs, line 8

Returns:

Type: NDArray

resize(a, new_shape) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray
`new_shape`	Array.<number>

Source:

resize.mjs, line 8

Returns:

Type: NDArray

roll(a, shift, axisopt) → {NDArray}

Parameters:

Name	Type	Attributes
`a`	NDArray
`shift`	number
`axis`	null \| number \| Array.<number>	<optional>

Source:

roll.mjs, line 22

Returns:

Type: NDArray

row_stack(arrs) → {NDArray}

Parameters:

Name	Type	Description
`arrs`	Array.<NDArray>

Source:

row_stack.mjs, line 7

Returns:

Type: NDArray

s_(args) → {Array.<(null|number|Slice|string)>}

Parameters:

Name	Type	Description
`args`	null \| number \| Slice \| string \| Array.<(null\|number\|Slice\|string)>

Source:

s_.mjs, line 25

Returns:

Type: Array.<(null|number|Slice|string)>

scatter(a, indices, axisopt) → {ViewIterator}

Parameters:

Name	Type	Attributes	Default
`a`	NDArray
`indices`	Array.<(number\|Slice\|string\|null\|Array.<number>\|Array.<boolean>\|NDArray)>
`axis`	number	<optional>	0

Source:

scatter.mjs, line 24

Returns:

Type: ViewIterator

searchsorted(a, v, sideopt) → {NDArray}

Parameters:

Name	Type	Attributes
`a`	NDArray
`v`	NDArray
`side`	string	<optional>

Source:

searchsorted.mjs, line 9

Returns:

Type: NDArray

shape(a) → {Array.<number>}

Return the shape of an array without invoking array creation.

Parameters:

Name	Type	Description
`a`	*

Source:

shape.mjs, line 36

Returns:

Type: Array.<number>

slice(startopt, stopopt, stepopt) → {Slice}

Create a Slice instance

Parameters:

Name	Type	Attributes
`start`	number \| string \| null \| Array.<(number\|null)>	<optional>
`stop`	number	<optional>
`step`	number	<optional>

Source:

slice.mjs, line 203

Returns:

Type: Slice

Examples

// returns Slice.ellipsis
slice('...')

// returns Slice.colon
slice()

// returns new Slice(1, null, null)
slice(1)

// returns slice(null, null, -1)
slice('::-1')

// returns slice(null, -1, 1)
slice(':-1')

// returns slice(null, null, 1)
slice([,,1])

solve(a, b) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray
`b`	NDArray

Source:

linalg.mjs, line 23

Returns:

Type: NDArray

sort(a, axis, key) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray
`axis`	null \| number
`key`	function

Source:

sort.mjs, line 22

Returns:

Type: NDArray

split(ary, indices_or_sections, axisopt) → {NDArray}

Parameters:

Name	Type	Attributes
`ary`	NDArray
`indices_or_sections`	NDArray
`axis`	number	<optional>

Source:

split.mjs, line 20

Returns:

Type: NDArray

squeeze(a, axis) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray
`axis`	null \| number \| Array.<number>

Source:

squeeze.mjs, line 17

Returns:

Type: NDArray

stack(arrays, axisopt, outopt) → {NDArray}

Parameters:

Name	Type	Attributes
`arrays`	Array.<NDArray>
`axis`	number	<optional>
`out`	null \| NDArray	<optional>

Source:

stack.mjs, line 19

Returns:

Type: NDArray

std(a, axis, out, ddof, keepdims) → {NDArray}

Parameters:

Name	Type	Description
`a`	*
`axis`	*
`out`	*
`ddof`	*
`keepdims`	*

Source:

statistics.mjs, line 153

Returns:

Type: NDArray

swapaxes(a, axis1, axis2) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray
`axis1`	number
`axis2`	number

Source:

swapaxes.mjs, line 9

Returns:

Type: NDArray

take(a, indices, axisopt, outopt, modeopt) → {NDArray}

Parameters:

Name	Type	Attributes
`a`	NDArray
`indices`	Array.<any>
`axis`	null \| number	<optional>
`out`	NDArray	<optional>
`mode`	string	<optional>

Source:

take.mjs, line 12

Returns:

Type: NDArray

tile(a, reps) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray
`reps`	number

Source:

tile.mjs, line 8

Returns:

Type: NDArray

transpose(a, axesopt) → {NDArray}

Parameters:

Name	Type	Attributes	Description
`a`	NDArray
`axes`	null \| Array.<number>	<optional>

Source:

transpose.mjs, line 8

Returns:

Type: NDArray

trapz(y, xopt, dxopt, axisopt) → {NDArray}

Parameters:

Name	Type	Attributes
`y`	NDArray
`x`	null \| NDArray	<optional>
`dx`	number	<optional>
`axis`	number	<optional>

Source:

trapz.mjs, line 24

Returns:

Type: NDArray

unique(a) → {NDArray}

Parameters:

Name	Type	Description
`a`	NDArray	array-like

Source:

unique.mjs, line 7

Returns:

Type: NDArray

unravel_index(indices, shape) → {Array.<NDArray>}

Expects non-negative indices

Parameters:

Name	Type	Description
`indices`	NDArray	array-like
`shape`	Array.<number>

Source:

unravel_index.mjs, line 15

Returns:

Type: Array.<NDArray>

Examples

unravel_index([22, 41, 37], [7, 6])
// [array([3, 6, 6]), array([4, 5, 1])]

unravel_index(1621, [6, 7, 8, 9])
// [3, 1, 4, 1]

variance(a, axis, out, ddof, keepdims) → {NDArray}

Parameters:

Name	Type	Description
`a`	*
`axis`	*
`out`	*
`ddof`	*
`keepdims`	*

Source:

statistics.mjs, line 126

Returns:

Type: NDArray

vstack(arrays) → {NDArray}

Parameters:

Name	Type	Description
`arrays`	Array.<NDArray>

Source:

vstack.mjs, line 23

Returns:

Type: NDArray

where(condition, xopt, yopt) → {NDArray}

Parameters:

Name	Type	Attributes
`condition`	NDArray
`x`	null \| NDArray	<optional>
`y`	null \| NDArray	<optional>

Source:

where.mjs, line 22

Returns:

Type: NDArray

zeros(shape, dtypeopt) → {NDArray}

Parameters:

Name	Type	Attributes	Description
`shape`	Array.<number>
`dtype`	Dtype	<optional>

Source:

zeros.mjs, line 8

Returns:

Type: NDArray

zeros_like(a, dtypeopt) → {NDArray}

Parameters:

Name	Type	Attributes	Description
`a`	NDArray		array-like
`dtype`	Dtype	<optional>

Source:

zeros.mjs, line 17

Returns:

Type: NDArray

Type Definitions

BroadcastResult

Type:

Object

Properties:

Name	Type	Description
`value`	any
`done`	boolean

Source:

broadcast.mjs, line 39

FlatiterResult

Type:

Object

Properties:

Name	Type	Description
`value`	any
`done`	boolean

Source:

flat.mjs, line 29

FormatOptions

Type:

Object

Properties:

Name	Type	Description
`edgeitems`	number
`threshold`	number
`precision`	number \| undefined
`linewidth`	number
`formatter`	number \| null
`separator`	string
`prefix`	string

Source:

array2string.mjs, line 90

NdenumerateResult

Type:

Object

Properties:

Name	Type	Description
`value`	Array.<Array.<number>, any>
`done`	boolean

Source:

ndenumerate.mjs, line 24

NdindexResult

Type:

Object

Properties:

Name	Type	Description
`value`	Array.<number>
`done`	boolean

Source:

ndindex.mjs, line 41

NdoffsetResult

Type:

Object

Properties:

Name	Type	Description
`value`	number
`done`	boolean

Source:

ndoffset.mjs, line 48

SliceIteratorResult

Type:

Object

Properties:

Name	Type	Description
`value`	number
`done`	boolean

Source:

slice.mjs, line 141