time-to-botec/squiggle/node_modules/@stdlib/array/linspace/README.md

Linspace

Generate a linearly spaced numeric array.

Usage

var linspace = require( '@stdlib/array/linspace' );

linspace( start, stop[, length] )

Generates a linearly spaced numeric array. If a length is not provided, the default output array length is 100.

var arr = linspace( 0, 100, 6 );
// returns [ 0, 20, 40, 60, 80, 100 ]

Notes

• The output array is guaranteed to include the start and stop values. Beware, however, that values between the start and stop are subject to floating-point errors. Hence,

  var arr = linspace( 0, 1, 3 );
  // returns [ 0, ~0.5, 1 ]
  

  where arr[1] is only guaranteed to be approximately equal to 0.5. If you desire more control over element precision, consider using roundn:

  var roundn = require( '@stdlib/math/base/special/roundn' );
  
  // Create an array subject to floating-point errors:
  var arr = linspace( 0, 1, 21 );
  
  // Round each value to the nearest hundredth:
  var out = [];
  var i;
  for ( i = 0; i < arr.length; i++ ) {
      out.push( roundn( arr[ i ], -2 ) );
  }
  
  console.log( out.join( '\n' ) );
  

Examples

var linspace = require( '@stdlib/array/linspace' );
var out;

// Default behavior:
out = linspace( 0, 10 );
console.log( out.join( '\n' ) );

// Specify length:
out = linspace( 0, 10, 10 );
console.log( out.join( '\n' ) );

out = linspace( 0, 10, 11 );
console.log( out.join( '\n' ) );

// Create an array with decremented values:
out = linspace( 10, 0, 11 );
console.log( out.join( '\n' ) );