/* * @license Apache-2.0 * * Copyright (c) 2023 The Stdlib Authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /* eslint-disable max-lines, jsdoc/check-param-names */ // TypeScript Version: 4.1 /// import { typedndarray, genericndarray, float64ndarray, float32ndarray, int32ndarray, int16ndarray, int8ndarray, uint32ndarray, uint16ndarray, uint8ndarray, uint8cndarray, complex128ndarray, complex64ndarray } from '@stdlib/types/ndarray'; import { ArrayLike } from '@stdlib/types/array'; /** * Interface defining function options. */ interface Options { /** * Boolean indicating whether to enforce strict bounds checking (default: true). */ strict?: boolean; } /** * Starting index. * * ## Notes * * - A value of `null` or `undefined` indicates to include all elements along a corresponding dimension. * - A negative integer indicates to resolve a starting index relative to the last element along a corresponding dimension, with the last element having index `-1`. */ type StartArgument = null | undefined | number; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float64' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] * * var s = [ 1, null ]; * var y = sliceFrom( x, s ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] */ declare function sliceFrom( x: float64ndarray, start: ArrayLike, options?: Options ): float64ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float64' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] * * var y = sliceFrom( x, 1, null ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] */ declare function sliceFrom( x: float64ndarray, ...start: Array ): float64ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float32' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'float32', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] * * var s = [ 1, null ]; * var y = sliceFrom( x, s ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] */ declare function sliceFrom( x: float32ndarray, start: ArrayLike, options?: Options ): float32ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float32' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'float32', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] * * var y = sliceFrom( x, 1, null ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] */ declare function sliceFrom( x: float32ndarray, ...start: Array ): float32ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'int32' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'int32', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var s = [ 1, null ]; * var y = sliceFrom( x, s ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: int32ndarray, start: ArrayLike, options?: Options ): int32ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'int32' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'int32', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var y = sliceFrom( x, 1, null ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: int32ndarray, ...start: Array ): int32ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'int16' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'int16', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var s = [ 1, null ]; * var y = sliceFrom( x, s ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: int16ndarray, start: ArrayLike, options?: Options ): int16ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'int16' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'int16', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var y = sliceFrom( x, 1, null ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: int16ndarray, ...start: Array ): int16ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'int8' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'int8', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var s = [ 1, null ]; * var y = sliceFrom( x, s ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: int8ndarray, start: ArrayLike, options?: Options ): int8ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'int8' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'int8', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var y = sliceFrom( x, 1, null ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: int8ndarray, ...start: Array ): int8ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint32' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'uint32', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var s = [ 1, null ]; * var y = sliceFrom( x, s ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: uint32ndarray, start: ArrayLike, options?: Options ): uint32ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint32' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'uint32', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var y = sliceFrom( x, 1, null ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: uint32ndarray, ...start: Array ): uint32ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint16' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'uint16', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var s = [ 1, null ]; * var y = sliceFrom( x, s ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: uint16ndarray, start: ArrayLike, options?: Options ): uint16ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint16' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'uint16', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var y = sliceFrom( x, 1, null ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: uint16ndarray, ...start: Array ): uint16ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint8' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'uint8', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var s = [ 1, null ]; * var y = sliceFrom( x, s ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: uint8ndarray, start: ArrayLike, options?: Options ): uint8ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint8' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'uint8', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var y = sliceFrom( x, 1, null ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: uint8ndarray, ...start: Array ): uint8ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint8c' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var s = [ 1, null ]; * var y = sliceFrom( x, s ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: uint8cndarray, start: ArrayLike, options?: Options ): uint8cndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1, 2, 3, 4, 5, 6 ], 'uint8c' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var y = sliceFrom( x, 1, null ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: uint8cndarray, ...start: Array ): uint8cndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ], 'complex128' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'complex128', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var s = [ 1, null ]; * var y = sliceFrom( x, s ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] */ declare function sliceFrom( x: complex128ndarray, start: ArrayLike, options?: Options ): complex128ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ], 'complex128' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'complex128', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var y = sliceFrom( x, 1, null ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] */ declare function sliceFrom( x: complex128ndarray, ...start: Array ): complex128ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ], 'complex64' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'complex64', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var s = [ 1, null ]; * var y = sliceFrom( x, s ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] */ declare function sliceFrom( x: complex64ndarray, start: ArrayLike, options?: Options ): complex64ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var typedarray = require( '@stdlib/array/typed' ); * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ], 'complex64' ); * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'complex64', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var y = sliceFrom( x, 1, null ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] */ declare function sliceFrom( x: complex64ndarray, ...start: Array ): complex64ndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = [ 1, 2, 3, 4, 5, 6 ]; * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var s = [ 1, null ]; * var y = sliceFrom( x, s ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: genericndarray, start: ArrayLike, options?: Options ): genericndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = [ 1, 2, 3, 4, 5, 6 ]; * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var y = sliceFrom( x, 1, null ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: genericndarray, ...start: Array ): genericndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = [ 1, 2, 3, 4, 5, 6 ]; * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var s = [ 1, null ]; * var y = sliceFrom( x, s ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: typedndarray, start: ArrayLike, options?: Options ): typedndarray; /** * Returns a read-only shifted view of an input ndarray. * * @param x - input array * @param start - starting indices (inclusive) * @param options - function options * @param options.strict - boolean indicating whether to enforce strict bounds checking * @returns output array * * @example * var ndarray = require( '@stdlib/ndarray/ctor' ); * var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = [ 1, 2, 3, 4, 5, 6 ]; * var shape = [ 3, 2 ]; * var strides = [ 2, 1 ]; * var offset = 0; * * var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' ); * // returns * * var sh = x.shape; * // returns [ 3, 2 ] * * var arr = ndarray2array( x ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] * * var y = sliceFrom( x, 1, null ); * // returns * * sh = y.shape; * // returns [ 2, 2 ] * * arr = ndarray2array( y ); * // returns [ [ 3, 4 ], [ 5, 6 ] ] */ declare function sliceFrom( x: typedndarray, ...start: Array ): typedndarray; // EXPORTS // export = sliceFrom;