Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Nov 3, 2023
1 parent 5d67ab1 commit 3097f6e
Show file tree
Hide file tree
Showing 49 changed files with 156 additions and 161 deletions.
1 change: 0 additions & 1 deletion .github/.keepalive

This file was deleted.

3 changes: 1 addition & 2 deletions base/assert/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@

// TypeScript Version: 4.1

/* tslint:disable:max-line-length */
/* tslint:disable:max-file-line-count */
/* eslint-disable max-lines */

import isAllowedDataTypeCast = require( './../../../../base/assert/is-allowed-data-type-cast' );
import isBufferLengthCompatible = require( './../../../../base/assert/is-buffer-length-compatible' );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
* bool = isAllowedCast( 'float64', 'int32', 'safe' );
* // returns false
*/
declare function isAllowedCast( from: string, to: string, casting: string ): boolean; // tslint-disable-line max-line-length
declare function isAllowedCast( from: string, to: string, casting: string ): boolean;


// EXPORTS //
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ import { ArrayLike } from '@stdlib/types/array';
* var bool = isBufferLengthCompatibleShape( 3, shape );
* // returns false
*/
declare function isBufferLengthCompatibleShape( len: number, shape: ArrayLike<number> ): boolean; // tslint-disable-line max-line-length
declare function isBufferLengthCompatibleShape( len: number, shape: ArrayLike<number> ): boolean;


// EXPORTS //
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ import { ArrayLike } from '@stdlib/types/array';
* var bool = isBufferLengthCompatible( 4, shape, strides, offset );
* // returns false
*/
declare function isBufferLengthCompatible( len: number, shape: ArrayLike<number>, strides: ArrayLike<number>, offset: number ): boolean; // tslint-disable-line max-line-length
declare function isBufferLengthCompatible( len: number, shape: ArrayLike<number>, strides: ArrayLike<number>, offset: number ): boolean;


// EXPORTS //
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ import { ArrayLike } from '@stdlib/types/array';
* var bool = isColumnMajorContiguous( shape, strides, offset );
* // returns false
*/
declare function isColumnMajorContiguous( shape: ArrayLike<number>, strides: ArrayLike<number>, offset: number ): boolean; // tslint-disable-line max-line-length
declare function isColumnMajorContiguous( shape: ArrayLike<number>, strides: ArrayLike<number>, offset: number ): boolean;


// EXPORTS //
Expand Down
2 changes: 1 addition & 1 deletion base/assert/is-contiguous/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ import { ArrayLike } from '@stdlib/types/array';
* var bool = isContiguous( shape, strides, offset );
* // returns false
*/
declare function isContiguous( shape: ArrayLike<number>, strides: ArrayLike<number>, offset: number ): boolean; // tslint-disable-line max-line-length
declare function isContiguous( shape: ArrayLike<number>, strides: ArrayLike<number>, offset: number ): boolean;


// EXPORTS //
Expand Down
2 changes: 1 addition & 1 deletion base/assert/is-row-major-contiguous/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ import { ArrayLike } from '@stdlib/types/array';
* var bool = isRowMajorContiguous( shape, strides, offset );
* // returns false
*/
declare function isRowMajorContiguous( shape: ArrayLike<number>, strides: ArrayLike<number>, offset: number ): boolean; // tslint-disable-line max-line-length
declare function isRowMajorContiguous( shape: ArrayLike<number>, strides: ArrayLike<number>, offset: number ): boolean;


// EXPORTS //
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ import { ArrayLike } from '@stdlib/types/array';
* var bool = isSingleSegmentCompatible( shape, strides, offset );
* // returns false
*/
declare function isSingleSegmentCompatible( shape: ArrayLike<number>, strides: ArrayLike<number>, offset: number ): boolean; // tslint-disable-line max-line-length
declare function isSingleSegmentCompatible( shape: ArrayLike<number>, strides: ArrayLike<number>, offset: number ): boolean;


// EXPORTS //
Expand Down
2 changes: 1 addition & 1 deletion base/binary-loop-interchange-order/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ interface LoopOrderObject {
* var ssz = o.sz;
* // returns [ 6, -2, 1 ]
*/
declare function binaryLoopOrder( shape: ArrayLike<number>, stridesX: ArrayLike<number>, stridesY: ArrayLike<number>, stridesZ: ArrayLike<number> ): LoopOrderObject; // tslint-disable-line max-line-length
declare function binaryLoopOrder( shape: ArrayLike<number>, stridesX: ArrayLike<number>, stridesY: ArrayLike<number>, stridesZ: ArrayLike<number> ): LoopOrderObject;


// EXPORTS //
Expand Down
2 changes: 1 addition & 1 deletion base/binary-tiling-block-size/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* var bsize = binaryBlockSize( 'float64', 'float64', 'float64' );
* // returns <number>
*/
declare function binaryBlockSize( dtypeX: string, dtypeY: string, dtypeZ: string ): number; // tslint-disable-line max-line-length
declare function binaryBlockSize( dtypeX: string, dtypeY: string, dtypeZ: string ): number;


// EXPORTS //
Expand Down
2 changes: 1 addition & 1 deletion base/bind2vind/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ import { Mode, Order } from '@stdlib/types/ndarray';
* var ind = bind2vind( shape, strides, offset, order, 7, mode );
* // returns 1
*/
declare function bind2vind( shape: ArrayLike<number>, strides: ArrayLike<number>, offset: number, order: Order, idx: number, mode: Mode ): number; // tslint-disable-line max-line-length
declare function bind2vind( shape: ArrayLike<number>, strides: ArrayLike<number>, offset: number, order: Order, idx: number, mode: Mode ): number;


// EXPORTS //
Expand Down
2 changes: 1 addition & 1 deletion base/broadcast-array/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ import { ndarray } from '@stdlib/types/ndarray';
* v = y.get( 2, 1, 1 );
* // returns 4
*/
declare function broadcastArray( arr: ndarray, shape: ArrayLike<number> ): ndarray; // tslint:disable-line:max-line-length
declare function broadcastArray( arr: ndarray, shape: ArrayLike<number> ): ndarray;


// EXPORTS //
Expand Down
24 changes: 12 additions & 12 deletions base/broadcast-scalar/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ import { ndarray, float64ndarray, float32ndarray, int32ndarray, int16ndarray, in
* var v = x.get( 0, 1 );
* // returns 1.0
*/
declare function broadcastScalar( value: number, dtype: 'float64', shape: Shape, order: Order ): float64ndarray; // tslint:disable-line:max-line-length
declare function broadcastScalar( value: number, dtype: 'float64', shape: Shape, order: Order ): float64ndarray;

/**
* Broadcasts a scalar value to an ndarray having a specified shape.
Expand All @@ -69,7 +69,7 @@ declare function broadcastScalar( value: number, dtype: 'float64', shape: Shape,
* var v = x.get( 0, 1 );
* // returns 1.0
*/
declare function broadcastScalar( value: number, dtype: 'float32', shape: Shape, order: Order ): float32ndarray; // tslint:disable-line:max-line-length
declare function broadcastScalar( value: number, dtype: 'float32', shape: Shape, order: Order ): float32ndarray;

/**
* Broadcasts a scalar value to an ndarray having a specified shape.
Expand Down Expand Up @@ -109,7 +109,7 @@ declare function broadcastScalar( value: number, dtype: 'float32', shape: Shape,
* var im = imag( v );
* // returns 2.0
*/
declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex128', shape: Shape, order: Order ): complex128ndarray; // tslint:disable-line:max-line-length
declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex128', shape: Shape, order: Order ): complex128ndarray;

/**
* Broadcasts a scalar value to an ndarray having a specified shape.
Expand Down Expand Up @@ -149,7 +149,7 @@ declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex12
* var im = imagf( v );
* // returns 2.0
*/
declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex64', shape: Shape, order: Order ): complex64ndarray; // tslint:disable-line:max-line-length
declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex64', shape: Shape, order: Order ): complex64ndarray;

/**
* Broadcasts a scalar value to an ndarray having a specified shape.
Expand All @@ -173,7 +173,7 @@ declare function broadcastScalar( value: number | ComplexLike, dtype: 'complex64
* var v = x.get( 0, 1 );
* // returns 1
*/
declare function broadcastScalar( value: number, dtype: 'int32', shape: Shape, order: Order ): int32ndarray; // tslint:disable-line:max-line-length
declare function broadcastScalar( value: number, dtype: 'int32', shape: Shape, order: Order ): int32ndarray;

/**
* Broadcasts a scalar value to an ndarray having a specified shape.
Expand All @@ -197,7 +197,7 @@ declare function broadcastScalar( value: number, dtype: 'int32', shape: Shape, o
* var v = x.get( 0, 1 );
* // returns 1
*/
declare function broadcastScalar( value: number, dtype: 'int16', shape: Shape, order: Order ): int16ndarray; // tslint:disable-line:max-line-length
declare function broadcastScalar( value: number, dtype: 'int16', shape: Shape, order: Order ): int16ndarray;

/**
* Broadcasts a scalar value to an ndarray having a specified shape.
Expand All @@ -221,7 +221,7 @@ declare function broadcastScalar( value: number, dtype: 'int16', shape: Shape, o
* var v = x.get( 0, 1 );
* // returns 1
*/
declare function broadcastScalar( value: number, dtype: 'int8', shape: Shape, order: Order ): int8ndarray; // tslint:disable-line:max-line-length
declare function broadcastScalar( value: number, dtype: 'int8', shape: Shape, order: Order ): int8ndarray;

/**
* Broadcasts a scalar value to an ndarray having a specified shape.
Expand All @@ -245,7 +245,7 @@ declare function broadcastScalar( value: number, dtype: 'int8', shape: Shape, or
* var v = x.get( 0, 1 );
* // returns 1
*/
declare function broadcastScalar( value: number, dtype: 'uint32', shape: Shape, order: Order ): uint32ndarray; // tslint:disable-line:max-line-length
declare function broadcastScalar( value: number, dtype: 'uint32', shape: Shape, order: Order ): uint32ndarray;

/**
* Broadcasts a scalar value to an ndarray having a specified shape.
Expand All @@ -269,7 +269,7 @@ declare function broadcastScalar( value: number, dtype: 'uint32', shape: Shape,
* var v = x.get( 0, 1 );
* // returns 1
*/
declare function broadcastScalar( value: number, dtype: 'uint16', shape: Shape, order: Order ): uint16ndarray; // tslint:disable-line:max-line-length
declare function broadcastScalar( value: number, dtype: 'uint16', shape: Shape, order: Order ): uint16ndarray;

/**
* Broadcasts a scalar value to an ndarray having a specified shape.
Expand All @@ -293,7 +293,7 @@ declare function broadcastScalar( value: number, dtype: 'uint16', shape: Shape,
* var v = x.get( 0, 1 );
* // returns 1
*/
declare function broadcastScalar( value: number, dtype: 'uint8', shape: Shape, order: Order ): uint8ndarray; // tslint:disable-line:max-line-length
declare function broadcastScalar( value: number, dtype: 'uint8', shape: Shape, order: Order ): uint8ndarray;

/**
* Broadcasts a scalar value to an ndarray having a specified shape.
Expand All @@ -317,7 +317,7 @@ declare function broadcastScalar( value: number, dtype: 'uint8', shape: Shape, o
* var v = x.get( 0, 1 );
* // returns 1
*/
declare function broadcastScalar( value: number, dtype: 'uint8c', shape: Shape, order: Order ): uint8cndarray; // tslint:disable-line:max-line-length
declare function broadcastScalar( value: number, dtype: 'uint8c', shape: Shape, order: Order ): uint8cndarray;

/**
* Broadcasts a scalar value to an ndarray having a specified shape.
Expand All @@ -341,7 +341,7 @@ declare function broadcastScalar( value: number, dtype: 'uint8c', shape: Shape,
* var v = x.get( 0, 1 );
* // returns 1.0
*/
declare function broadcastScalar( value: any, dtype: DataType, shape: Shape, order: Order ): ndarray; // tslint:disable-line:max-line-length
declare function broadcastScalar( value: any, dtype: DataType, shape: Shape, order: Order ): ndarray;


// EXPORTS //
Expand Down
2 changes: 1 addition & 1 deletion base/broadcast-shapes/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ import { ArrayLike } from '@stdlib/types/array';
* var out = broadcastShapes( shapes );
* // returns [ 3, 2, 1 ]
*/
declare function broadcastShapes( shapes: ArrayLike<ArrayLike<number>> ): ArrayLike<number>; // tslint:disable-line:max-line-length
declare function broadcastShapes( shapes: ArrayLike<ArrayLike<number>> ): ArrayLike<number>;


// EXPORTS //
Expand Down
2 changes: 1 addition & 1 deletion base/buffer/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ type ArrayOrBufferOrTypedArray = Array<any> | TypedArray | Buffer | null;
* var buf = buffer( 'float64', 3 );
* // returns <Float64Array>[ 0.0, 0.0, 0.0 ]
*/
declare function buffer( dtype: DataType, size: number ): ArrayOrBufferOrTypedArray; // tslint-disable-line max-line-length
declare function buffer( dtype: DataType, size: number ): ArrayOrBufferOrTypedArray;


// EXPORTS //
Expand Down
4 changes: 2 additions & 2 deletions base/ctor/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ interface Constructor {
*
* var out = new ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
*/
new( dtype: DataType, buffer: ArrayLike<any> | Buffer, shape: Shape, strides: Strides, offset: number, order: Order ): ndarray; // tslint-disable-line max-line-length
new( dtype: DataType, buffer: ArrayLike<any> | Buffer, shape: Shape, strides: Strides, offset: number, order: Order ): ndarray;

/**
* ndarray constructor.
Expand Down Expand Up @@ -94,7 +94,7 @@ interface Constructor {
*
* var out = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
*/
( dtype: DataType, buffer: ArrayLike<any> | Buffer, shape: Shape, strides: Strides, offset: number, order: Order ): ndarray; // tslint-disable-line max-line-length
( dtype: DataType, buffer: ArrayLike<any> | Buffer, shape: Shape, strides: Strides, offset: number, order: Order ): ndarray;
}

/**
Expand Down
3 changes: 1 addition & 2 deletions base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@

// TypeScript Version: 4.1

/* tslint:disable:max-line-length */
/* tslint:disable:max-file-line-count */
/* eslint-disable max-lines */

import assert = require( './../../../base/assert' );
import assign = require( './../../../base/assign' );
Expand Down
2 changes: 1 addition & 1 deletion base/dtypes2signatures/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ import { ArrayLike } from '@stdlib/types/array';
* var sigs = dtypes2signatures( dtypes, 1, 1 );
* // returns [ '(float64) => (float64)', '(float32) => (float32)' ]
*/
declare function dtypes2signatures( dtypes: ArrayLike<any>, nin: number, nout: number ): ArrayLike<string>; // tslint:disable-line:max-line-length
declare function dtypes2signatures( dtypes: ArrayLike<any>, nin: number, nout: number ): ArrayLike<string>;


// EXPORTS //
Expand Down
26 changes: 13 additions & 13 deletions base/empty/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ import { Shape, Order, typedndarray, float64ndarray, float32ndarray, int32ndarra
* var dt = arr.dtype;
* // returns 'float64'
*/
declare function empty( dtype: 'float64', shape: Shape, order: Order ): float64ndarray; // tslint:disable-line:max-line-length
declare function empty( dtype: 'float64', shape: Shape, order: Order ): float64ndarray;

/**
* Creates an uninitialized array having a specified shape and data type.
Expand All @@ -60,7 +60,7 @@ declare function empty( dtype: 'float64', shape: Shape, order: Order ): float64n
* var dt = arr.dtype;
* // returns 'float32'
*/
declare function empty( dtype: 'float32', shape: Shape, order: Order ): float32ndarray; // tslint:disable-line:max-line-length
declare function empty( dtype: 'float32', shape: Shape, order: Order ): float32ndarray;

/**
* Creates an uninitialized array having a specified shape and data type.
Expand All @@ -80,7 +80,7 @@ declare function empty( dtype: 'float32', shape: Shape, order: Order ): float32n
* var dt = arr.dtype;
* // returns 'complex128'
*/
declare function empty( dtype: 'complex128', shape: Shape, order: Order ): complex128ndarray; // tslint:disable-line:max-line-length
declare function empty( dtype: 'complex128', shape: Shape, order: Order ): complex128ndarray;

/**
* Creates an uninitialized array having a specified shape and data type.
Expand All @@ -100,7 +100,7 @@ declare function empty( dtype: 'complex128', shape: Shape, order: Order ): compl
* var dt = arr.dtype;
* // returns 'complex64'
*/
declare function empty( dtype: 'complex64', shape: Shape, order: Order ): complex64ndarray; // tslint:disable-line:max-line-length
declare function empty( dtype: 'complex64', shape: Shape, order: Order ): complex64ndarray;

/**
* Creates an uninitialized array having a specified shape and data type.
Expand All @@ -120,7 +120,7 @@ declare function empty( dtype: 'complex64', shape: Shape, order: Order ): comple
* var dt = arr.dtype;
* // returns 'int32'
*/
declare function empty( dtype: 'int32', shape: Shape, order: Order ): int32ndarray; // tslint:disable-line:max-line-length
declare function empty( dtype: 'int32', shape: Shape, order: Order ): int32ndarray;

/**
* Creates an uninitialized array having a specified shape and data type.
Expand All @@ -140,7 +140,7 @@ declare function empty( dtype: 'int32', shape: Shape, order: Order ): int32ndarr
* var dt = arr.dtype;
* // returns 'int16'
*/
declare function empty( dtype: 'int16', shape: Shape, order: Order ): int16ndarray; // tslint:disable-line:max-line-length
declare function empty( dtype: 'int16', shape: Shape, order: Order ): int16ndarray;

/**
* Creates an uninitialized array having a specified shape and data type.
Expand All @@ -160,7 +160,7 @@ declare function empty( dtype: 'int16', shape: Shape, order: Order ): int16ndarr
* var dt = arr.dtype;
* // returns 'int8'
*/
declare function empty( dtype: 'int8', shape: Shape, order: Order ): int8ndarray; // tslint:disable-line:max-line-length
declare function empty( dtype: 'int8', shape: Shape, order: Order ): int8ndarray;

/**
* Creates an uninitialized array having a specified shape and data type.
Expand All @@ -180,7 +180,7 @@ declare function empty( dtype: 'int8', shape: Shape, order: Order ): int8ndarray
* var dt = arr.dtype;
* // returns 'uint32'
*/
declare function empty( dtype: 'uint32', shape: Shape, order: Order ): uint32ndarray; // tslint:disable-line:max-line-length
declare function empty( dtype: 'uint32', shape: Shape, order: Order ): uint32ndarray;

/**
* Creates an uninitialized array having a specified shape and data type.
Expand All @@ -200,7 +200,7 @@ declare function empty( dtype: 'uint32', shape: Shape, order: Order ): uint32nda
* var dt = arr.dtype;
* // returns 'uint16'
*/
declare function empty( dtype: 'uint16', shape: Shape, order: Order ): uint16ndarray; // tslint:disable-line:max-line-length
declare function empty( dtype: 'uint16', shape: Shape, order: Order ): uint16ndarray;

/**
* Creates an uninitialized array having a specified shape and data type.
Expand All @@ -220,7 +220,7 @@ declare function empty( dtype: 'uint16', shape: Shape, order: Order ): uint16nda
* var dt = arr.dtype;
* // returns 'uint8'
*/
declare function empty( dtype: 'uint8', shape: Shape, order: Order ): uint8ndarray; // tslint:disable-line:max-line-length
declare function empty( dtype: 'uint8', shape: Shape, order: Order ): uint8ndarray;

/**
* Creates an uninitialized array having a specified shape and data type.
Expand All @@ -240,7 +240,7 @@ declare function empty( dtype: 'uint8', shape: Shape, order: Order ): uint8ndarr
* var dt = arr.dtype;
* // returns 'uint8c'
*/
declare function empty( dtype: 'uint8c', shape: Shape, order: Order ): uint8cndarray; // tslint:disable-line:max-line-length
declare function empty( dtype: 'uint8c', shape: Shape, order: Order ): uint8cndarray;

/**
* Creates a zero-filled array having a specified shape and data type.
Expand All @@ -260,7 +260,7 @@ declare function empty( dtype: 'uint8c', shape: Shape, order: Order ): uint8cnda
* var dt = arr.dtype;
* // returns 'generic'
*/
declare function empty( dtype: 'generic', shape: Shape, order: Order ): typedndarray<number>; // tslint:disable-line:max-line-length
declare function empty( dtype: 'generic', shape: Shape, order: Order ): typedndarray<number>;

/**
* Creates an uninitialized array having a specified shape and data type.
Expand All @@ -280,7 +280,7 @@ declare function empty( dtype: 'generic', shape: Shape, order: Order ): typednda
* var dt = arr.dtype;
* // returns 'float32'
*/
declare function empty( dtype: DataType, shape: Shape, order: Order ): typedndarray<number>; // tslint:disable-line:max-line-length unified-signatures
declare function empty( dtype: DataType, shape: Shape, order: Order ): typedndarray<number>; unified-signatures


// EXPORTS //
Expand Down
Loading

0 comments on commit 3097f6e

Please sign in to comment.