Skip to content

int32

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

int32

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
benchmark
benchmark
 
 
docs
docs
 
 
examples
examples
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

Int32Matrix

Create a 32-bit signed integer matrix (i.e., a two-dimensional ndarray).

Usage

var Int32Matrix = require( '@stdlib/ndarray/matrix/int32' );

Int32Matrix( [options] )

Returns a two-dimensional 32-bit signed integer ndarray.

var getShape = require( '@stdlib/ndarray/shape' );

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

var len = getShape( arr );
// returns [ 0, 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'.
  • submode: a mode array which specifies for each dimension how to handle subscripts which exceed array dimensions (see ndarray). If provided fewer modes than dimensions, an ndarray) instance recycles modes using modulo arithmetic. Default: [ options.mode ].
  • readonly: boolean indicating whether an array should be read-only. Default: false.

Int32Matrix( shape[, options] )

Returns a two-dimensional 32-bit signed integer ndarray having a specified shape.

var getShape = require( '@stdlib/ndarray/shape' );

var arr = new Int32Matrix( [ 3, 3 ] );
// returns <ndarray>

var sh = getShape( arr );
// returns [ 3, 3 ]

The function accepts the following arguments:

  • shape: array shape. Must contain exactly two elements.
  • options: function options. See above.

Int32Matrix( M, N[, options] )

Returns a two-dimensional 32-bit signed integer ndarray having a specified shape.

var getShape = require( '@stdlib/ndarray/shape' );

var arr = new Int32Matrix( 3, 3 );
// returns <ndarray>

var sh = getShape( arr );
// returns [ 3, 3 ]

The function accepts the following arguments:

  • M: number of rows.
  • N: number of columns.
  • options: function options. See above.

Int32Matrix( obj[, options] )

Creates a two-dimensional 32-bit signed integer ndarray from an array-like object or iterable.

var getShape = require( '@stdlib/ndarray/shape' );

var arr = new Int32Matrix( [ [ 1, 2 ], [ 3, 4 ] ] );
// returns <ndarray>

var sh = getShape( arr );
// returns [ 2, 2 ]

The function accepts the following arguments:

  • obj: array-like object or iterable from which to generate an ndarray. If an array-like object, the value must be a nested array (i.e., an array-like object of array-like objects), where each nested array must have the same number of elements. If an iterable, the iterable must return array-like objects, each of which must have the same number of elements.
  • options: function options. See above.

Int32Matrix( buffer[, byteOffset[, shape]][, options] )

Returns a two-dimensional 32-bit signed integer ndarray view of an ArrayBuffer.

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

var buf = new ArrayBuffer( 64 );

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

var sh1 = getShape( arr1 );
// returns [ 1, 16 ]

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

var sh2 = getShape( arr2 );
// returns [ 1, 12 ]

var arr3 = new Int32Matrix( buf, 16, [ 2, 1 ] );
// returns <ndarray>

var sh3 = getShape( arr3 );
// returns [ 2, 1 ]

The function accepts the following arguments:

  • buffer: underlying ArrayBuffer.
  • byteOffset: integer byte offset specifying the location of the first indexed element. Default: 0.
  • shape: array shape. Must contain exactly two elements.
  • options: function options. See above.

Int32Matrix( buffer[, byteOffset[, M, N]][, options] )

Returns a two-dimensional 32-bit signed integer ndarray view of an ArrayBuffer.

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

var buf = new ArrayBuffer( 64 );

var arr = new Int32Matrix( buf, 16, 2, 1 );
// returns <ndarray>

var sh = getShape( arr );
// returns [ 2, 1 ]

The function accepts the following arguments:

  • buffer: underlying ArrayBuffer.
  • byteOffset: integer byte offset specifying the location of the first indexed element. Default: 0.
  • M: number of rows.
  • N: number of columns.
  • options: function options. See above.

Notes

  • Nested arrays are flattened in lexicographic order, such that, for an input nested array obj, obj[i][j] corresponds to the element mat.get(i, j) in the returned two-dimensional ndarray. In other words, an input nested array is assumed to be comprised of rows. Similarly, if obj is an iterable, each array returned by the iterable is assumed to correspond to a matrix row.
  • If provided an ArrayBuffer without corresponding shape arguments, the leading dimension of the returned ndarray always has a size of one.

Examples

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var sum = require( '@stdlib/blas/ext/sum' );
var map = require( '@stdlib/ndarray/map' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var Int32Matrix = require( '@stdlib/ndarray/matrix/int32' );

// Create a matrix containing random values:
var x = new Int32Matrix([
    discreteUniform( 10, 0, 100 ),
    discreteUniform( 10, 0, 20 )
]);

// Compute the sum along the columns:
var v = sum( x, {
    'dims': [ -1 ]
});
console.log( ndarray2array( v ) );

// 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 along the columns:
v = sum( y, {
    'dims': [ -1 ]
});
console.log( ndarray2array( v ) );

See Also