Skip to content

Commit 0293981

Browse files
PlaneshifterPlaneshifter
authored
docs: replace "array" with "ndarray" in various type declarations
PR-URL: #12828 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 62beca8 commit 0293981

17 files changed

Lines changed: 221 additions & 221 deletions

File tree

‎lib/node_modules/@stdlib/ndarray/base/docs/types/index.d.ts‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1935,7 +1935,7 @@ interface Namespace {
19351935
* @param dtype - underlying data type
19361936
* @param shape - array shape
19371937
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
1938-
* @returns `false`-filled array
1938+
* @returns `false`-filled ndarray
19391939
*
19401940
* @example
19411941
* var getDType = require( '@stdlib/ndarray/dtype' );
@@ -3082,12 +3082,12 @@ interface Namespace {
30823082
minmaxViewBufferIndex: typeof minmaxViewBufferIndex;
30833083

30843084
/**
3085-
* Creates a NaN-filled array having a specified shape and data type.
3085+
* Creates a NaN-filled ndarray having a specified shape and data type.
30863086
*
30873087
* @param dtype - underlying data type
30883088
* @param shape - array shape
30893089
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
3090-
* @returns NaN-filled array
3090+
* @returns NaN-filled ndarray
30913091
*
30923092
* @example
30933093
* var getDType = require( '@stdlib/ndarray/dtype' );
@@ -3101,10 +3101,10 @@ interface Namespace {
31013101
nans: typeof nans;
31023102

31033103
/**
3104-
* Creates a NaN-filled array having the same shape and data type as a provided input ndarray.
3104+
* Creates a NaN-filled ndarray having the same shape and data type as a provided input ndarray.
31053105
*
31063106
* @param x - input array
3107-
* @returns NaN-filled array
3107+
* @returns NaN-filled ndarray
31083108
*
31093109
* @example
31103110
* var getShape = require( '@stdlib/ndarray/shape' );
@@ -3501,12 +3501,12 @@ interface Namespace {
35013501
nullaryBlockSize: typeof nullaryBlockSize;
35023502

35033503
/**
3504-
* Creates a null-filled array having a specified shape and data type.
3504+
* Creates a null-filled ndarray having a specified shape and data type.
35053505
*
35063506
* @param dtype - underlying data type
35073507
* @param shape - array shape
35083508
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
3509-
* @returns null-filled array
3509+
* @returns null-filled ndarray
35103510
*
35113511
* @example
35123512
* var getDType = require( '@stdlib/ndarray/dtype' );
@@ -3594,12 +3594,12 @@ interface Namespace {
35943594
offset: typeof offset;
35953595

35963596
/**
3597-
* Creates a ones-filled array having a specified shape and data type.
3597+
* Creates a ones-filled ndarray having a specified shape and data type.
35983598
*
35993599
* @param dtype - underlying data type
36003600
* @param shape - array shape
36013601
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
3602-
* @returns ones-filled array
3602+
* @returns ones-filled ndarray
36033603
*
36043604
* @example
36053605
* var getShape = require( '@stdlib/ndarray/shape' );
@@ -3617,10 +3617,10 @@ interface Namespace {
36173617
ones: typeof ones;
36183618

36193619
/**
3620-
* Creates a ones-filled array having the same shape and data type as a provided input ndarray.
3620+
* Creates a ones-filled ndarray having the same shape and data type as a provided input ndarray.
36213621
*
36223622
* @param x - input array
3623-
* @returns ones-filled array
3623+
* @returns ones-filled ndarray
36243624
*
36253625
* @example
36263626
* var getShape = require( '@stdlib/ndarray/shape' );
@@ -5590,7 +5590,7 @@ interface Namespace {
55905590
* @param dtype - underlying data type
55915591
* @param shape - array shape
55925592
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
5593-
* @returns `true`-filled array
5593+
* @returns `true`-filled ndarray
55945594
*
55955595
* @example
55965596
* var getDType = require( '@stdlib/ndarray/dtype' );
@@ -6272,12 +6272,12 @@ interface Namespace {
62726272
wrapIndex: typeof wrapIndex;
62736273

62746274
/**
6275-
* Creates a zero-filled array having a specified shape and data type.
6275+
* Creates a zero-filled ndarray having a specified shape and data type.
62766276
*
62776277
* @param dtype - underlying data type
62786278
* @param shape - array shape
62796279
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
6280-
* @returns zero-filled array
6280+
* @returns zero-filled ndarray
62816281
*
62826282
* @example
62836283
* var getShape = require( '@stdlib/ndarray/shape' );
@@ -6295,10 +6295,10 @@ interface Namespace {
62956295
zeros: typeof zeros;
62966296

62976297
/**
6298-
* Creates a zero-filled array having the same shape and data type as a provided input ndarray.
6298+
* Creates a zero-filled ndarray having the same shape and data type as a provided input ndarray.
62996299
*
63006300
* @param x - input array
6301-
* @returns zero-filled array
6301+
* @returns zero-filled ndarray
63026302
*
63036303
* @example
63046304
* var getShape = require( '@stdlib/ndarray/shape' );

‎lib/node_modules/@stdlib/ndarray/base/falses/docs/types/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { Shape, Order, boolndarray, genericndarray, BooleanDataType, GenericData
2828
* @param dtype - underlying data type
2929
* @param shape - array shape
3030
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
31-
* @returns `false`-filled array
31+
* @returns `false`-filled ndarray
3232
*
3333
* @example
3434
* var getDType = require( '@stdlib/ndarray/dtype' );
@@ -47,7 +47,7 @@ declare function falses( dtype: BooleanDataType, shape: Shape, order: Order ): b
4747
* @param dtype - underlying data type
4848
* @param shape - array shape
4949
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
50-
* @returns `false`-filled array
50+
* @returns `false`-filled ndarray
5151
*
5252
* @example
5353
* var getDType = require( '@stdlib/ndarray/dtype' );

‎lib/node_modules/@stdlib/ndarray/base/nans-like/docs/types/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
import { realcomplexndarray, genericndarray } from '@stdlib/types/ndarray';
2424

2525
/**
26-
* Creates a NaN-filled array having the same shape and data type as a provided input ndarray.
26+
* Creates a NaN-filled ndarray having the same shape and data type as a provided input ndarray.
2727
*
2828
* @param x - input array
29-
* @returns NaN-filled array
29+
* @returns NaN-filled ndarray
3030
*
3131
* @example
3232
* var getShape = require( '@stdlib/ndarray/shape' );

‎lib/node_modules/@stdlib/ndarray/base/nans/docs/types/index.d.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@
2323
import { Shape, Order, typedndarray, genericndarray, float64ndarray, float32ndarray, complex128ndarray, complex64ndarray, FloatingPointAndGenericDataType, GenericDataType, Float64DataType, Float32DataType, Complex128DataType, Complex64DataType } from '@stdlib/types/ndarray';
2424

2525
/**
26-
* Creates a NaN-filled array having a specified shape and data type.
26+
* Creates a NaN-filled ndarray having a specified shape and data type.
2727
*
2828
* @param dtype - underlying data type
2929
* @param shape - array shape
3030
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
31-
* @returns NaN-filled array
31+
* @returns NaN-filled ndarray
3232
*
3333
* @example
3434
* var getDType = require( '@stdlib/ndarray/dtype' );
@@ -42,12 +42,12 @@ import { Shape, Order, typedndarray, genericndarray, float64ndarray, float32ndar
4242
declare function nans( dtype: Float64DataType, shape: Shape, order: Order ): float64ndarray;
4343

4444
/**
45-
* Creates a NaN-filled array having a specified shape and data type.
45+
* Creates a NaN-filled ndarray having a specified shape and data type.
4646
*
4747
* @param dtype - underlying data type
4848
* @param shape - array shape
4949
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
50-
* @returns NaN-filled array
50+
* @returns NaN-filled ndarray
5151
*
5252
* @example
5353
* var getDType = require( '@stdlib/ndarray/dtype' );
@@ -61,12 +61,12 @@ declare function nans( dtype: Float64DataType, shape: Shape, order: Order ): flo
6161
declare function nans( dtype: Float32DataType, shape: Shape, order: Order ): float32ndarray;
6262

6363
/**
64-
* Creates a NaN-filled array having a specified shape and data type.
64+
* Creates a NaN-filled ndarray having a specified shape and data type.
6565
*
6666
* @param dtype - underlying data type
6767
* @param shape - array shape
6868
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
69-
* @returns NaN-filled array
69+
* @returns NaN-filled ndarray
7070
*
7171
* @example
7272
* var getDType = require( '@stdlib/ndarray/dtype' );
@@ -80,12 +80,12 @@ declare function nans( dtype: Float32DataType, shape: Shape, order: Order ): flo
8080
declare function nans( dtype: Complex128DataType, shape: Shape, order: Order ): complex128ndarray;
8181

8282
/**
83-
* Creates a NaN-filled array having a specified shape and data type.
83+
* Creates a NaN-filled ndarray having a specified shape and data type.
8484
*
8585
* @param dtype - underlying data type
8686
* @param shape - array shape
8787
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
88-
* @returns NaN-filled array
88+
* @returns NaN-filled ndarray
8989
*
9090
* @example
9191
* var getDType = require( '@stdlib/ndarray/dtype' );
@@ -99,12 +99,12 @@ declare function nans( dtype: Complex128DataType, shape: Shape, order: Order ):
9999
declare function nans( dtype: Complex64DataType, shape: Shape, order: Order ): complex64ndarray;
100100

101101
/**
102-
* Creates a NaN-filled array having a specified shape and data type.
102+
* Creates a NaN-filled ndarray having a specified shape and data type.
103103
*
104104
* @param dtype - underlying data type
105105
* @param shape - array shape
106106
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
107-
* @returns NaN-filled array
107+
* @returns NaN-filled ndarray
108108
*
109109
* @example
110110
* var getDType = require( '@stdlib/ndarray/dtype' );
@@ -118,12 +118,12 @@ declare function nans( dtype: Complex64DataType, shape: Shape, order: Order ): c
118118
declare function nans( dtype: GenericDataType, shape: Shape, order: Order ): genericndarray<number>;
119119

120120
/**
121-
* Creates a NaN-filled array having a specified shape and data type.
121+
* Creates a NaN-filled ndarray having a specified shape and data type.
122122
*
123123
* @param dtype - underlying data type
124124
* @param shape - array shape
125125
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
126-
* @returns NaN-filled array
126+
* @returns NaN-filled ndarray
127127
*
128128
* @example
129129
* var getDType = require( '@stdlib/ndarray/dtype' );

‎lib/node_modules/@stdlib/ndarray/base/nulls/docs/types/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@
2323
import { Shape, Order, genericndarray, GenericDataType } from '@stdlib/types/ndarray';
2424

2525
/**
26-
* Creates a null-filled array having a specified shape and data type.
26+
* Creates a null-filled ndarray having a specified shape and data type.
2727
*
2828
* @param dtype - underlying data type
2929
* @param shape - array shape
3030
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
31-
* @returns null-filled array
31+
* @returns null-filled ndarray
3232
*
3333
* @example
3434
* var getDType = require( '@stdlib/ndarray/dtype' );

‎lib/node_modules/@stdlib/ndarray/base/ones-like/docs/types/index.d.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ import { ComplexLike } from '@stdlib/types/complex';
2424
import { typedndarray } from '@stdlib/types/ndarray';
2525

2626
/**
27-
* Creates a ones-filled array having the same shape and data type as a provided input ndarray.
27+
* Creates a ones-filled ndarray having the same shape and data type as a provided input ndarray.
2828
*
2929
* @param x - input array
30-
* @returns ones-filled array
30+
* @returns ones-filled ndarray
3131
*
3232
* @example
3333
* var getShape = require( '@stdlib/ndarray/shape' );

0 commit comments

Comments
 (0)