Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions lib/node_modules/@stdlib/array/base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,13 +226,111 @@ The namespace exports the following:

<!-- eslint no-undef: "error" -->

#### print List of functions in array/base

```javascript
var objectKeys = require( '@stdlib/utils/keys' );
var ns = require( '@stdlib/array/base' );

console.log( objectKeys( ns ) );
```

#### Functions for creating arrays

1 . Create arrays with all zeros ( useful for defining output arrays )

```javascript
var zeros = require( '@stdlib/array/base/zeros' );
var zeros2d = require( '@stdlib/array/base/zeros2d' );

// One dimensional array with 10 zeros
var array = zeros( 10 );
console.log( array );

// Two dimensional array of dimensions 4 x 4, with all zeros
var array2d = zeros2d( [4, 4] );
console.log( array2d );
```

2 . Create array filled with a specific value

```javascript
var filled = require( '@stdlib/array/base/filled' );
var filled2d = require( '@stdlib/array/base/filled2d' );

// One dimensional array of length 10 with all elements equal to 3
var array = filled( 3, 10 );
console.log( array );

// Two dimensional array of dimensions 4 x 4 with all elements equal to 1
var array2d = filled2d( 1, [4, 4] );
console.log( array2d );
```

3 . Create linearly spaced array with difference 1 and starting from 0/1

```javascript
var zeroTo = require( '@stdlib/array/base/zero-to' );
var oneTo = require( '@stdlib/array/base/one-to' );

// Linearly spcaed array 0, 1, 2, 3, 4, 5 (starting from 0 and of length 6)
var zeroArray = zeroTo( 6 );
console.log( zeroArray );

// Linearly spaced array 1, 2, 3, 4, 5, 6 (starting from 1 and of length 6)
var oneArray = oneTo( 6 );
console.log( oneArray );
```

4 . Generic spaced arrays

```javascript
var unitspace = require( '@stdlib/array/base/unitspace' );
var linspace = require( '@stdlib/array/base/linspace' );
var logspace = require( '@stdlib/array/base/logspace' );

// Array with elements spaced at unit value in [start, end)
var array = unitspace( 12, 17 );
console.log( array ); // [ 12, 13, 14, 15, 16, 17 ]

// Create array with elements in arithmetic progression (boundaries included)
var lineArray = linspace( 5, 19, 3 );
console.log( lineArray ); // [ 5, 8, 11, 14, 17 ]

// Create a logarithmically spaced numeric array between 10^0 and 10^6 having 7 elements
var logArray = logspace( 0, 6, 7 ); // [ 1, 10, 100, 1000, 10000, 100000, 1000000 ]
console.log(logArray);
```

##### Miscellaneous use

Creating a two dimensional array with all elements equal to a random number

```javascript
var bernoulli = require( '@stdlib/random/base/bernoulli' );
var filled2d = require( '@stdlib/array/base/filled2d' );
var rand = bernoulli.factory( 0.6 );

var matrix = filled2d( rand(), [ 3, 3 ] );
console.log( matrix );
```

creating array of elements with periodic values for trigonometric functions

```javascript
var PI = require( '@stdlib/constants/float64/pi' );
var linspace = require( '@stdlib/array/base/linspace' );
var sin = require( '@stdlib/math/base/special/sin' );
var args = linspace( 0, 2 * PI, 9);
var i;

// [0, π/4, π/2, 3π/4, π, 5π/4, 3π/2, 7π/4, 2π]
for ( i = 0; i < args.length; i++)
{
console.log( sin( args[i] ) );
}
```

</section>

<!-- /.examples -->
Expand Down