Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Float32Vector

Create a single-precision floating-point vector (i.e., a one-dimensional ndarray).

Usage

var Float32Vector = require( '@stdlib/ndarray/vector/float32' );

Float32Vector( [options] )

Returns a one-dimensional single-precision floating-point ndarray.

var numel = require( '@stdlib/ndarray/numel' );

var arr = new Float32Vector();
// returns <ndarray>

var len = numel( arr );
// returns 0

The function accepts the following options:

  • order: specifies whether an ndarray is 'row-major' (C-style) or 'column-major' (Fortran-style). Default: 'row-major'.
  • mode: specifies how to handle indices which exceed array dimensions (see ndarray). Default: 'throw'.
  • readonly: boolean indicating whether an array should be read-only. Default: false.

Float32Vector( length[, options] )

Returns a one-dimensional single-precision floating-point ndarray having a specified length.

var numel = require( '@stdlib/ndarray/numel' );

var arr = new Float32Vector( 5 );
// returns <ndarray>

var len1 = numel( arr );
// returns 5

Float32Vector( obj[, options] )

Creates a one-dimensional single-precision floating-point ndarray from an array-like object or iterable.

var numel = require( '@stdlib/ndarray/numel' );

var arr = new Float32Vector( [ 1.0, 2.0, 3.0 ] );
// returns <ndarray>

var len1 = numel( arr );
// returns 3

Float32Vector( buffer[, byteOffset[, length]][, options] )

Returns a one-dimensional single-precision floating-point ndarray view of an ArrayBuffer.

var ArrayBuffer = require( '@stdlib/array/buffer' );
var numel = require( '@stdlib/ndarray/numel' );

var buf = new ArrayBuffer( 32 );

var arr1 = new Float32Vector( buf );
// returns <ndarray>

var len1 = numel( arr1 );
// returns 8

var arr2 = new Float32Vector( buf, 16 );
// returns <ndarray>

var len2 = numel( arr2 );
// returns 4

var arr3 = new Float32Vector( buf, 16, 1 );
// returns <ndarray>

var len3 = numel( arr3 );
// returns 1

Examples

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var sum = require( '@stdlib/blas/ext/sum' );
var map = require( '@stdlib/ndarray/map' );
var Float32Vector = require( '@stdlib/ndarray/vector/float32' );

// Create a vector containing random values:
var x = new Float32Vector( discreteUniform( 10, 0, 100 ) );

// Compute the sum:
var v = sum( x );
console.log( v.get() );

// Define a function which applies a threshold to individual values:
function threshold( v ) {
    return ( v > 10 ) ? v : 0;
}

// Apply threshold:
var y = map( x, threshold );

// Recompute the sum:
v = sum( y );
console.log( v.get() );