About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Complex64Matrix

Create a single-precision complex floating-point matrix (i.e., a two-dimensional ndarray).

Installation

npm install @stdlib/ndarray-matrix-complex64

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var Complex64Matrix = require( '@stdlib/ndarray-matrix-complex64' );

Complex64Matrix( [options] )

Returns a two-dimensional single-precision complex floating-point ndarray.

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

var arr = new Complex64Matrix();
// 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.

Complex64Matrix( shape[, options] )

Returns a two-dimensional single-precision complex floating-point ndarray having a specified shape.

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

var arr = new Complex64Matrix( [ 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.

Complex64Matrix( M, N[, options] )

Returns a two-dimensional single-precision complex floating-point ndarray having a specified shape.

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

var arr = new Complex64Matrix( 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.

Complex64Matrix( obj[, options] )

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

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

var arr = new Complex64Matrix( [ [ 1.0, 2.0, 3.0, 4.0 ], [ 5.0, 6.0, 7.0, 8.0 ] ] );
// 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.

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

Returns a two-dimensional single-precision complex floating-point 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 Complex64Matrix( buf );
// returns <ndarray>

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

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

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

var arr3 = new Complex64Matrix( 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.

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

Returns a two-dimensional single-precision complex floating-point 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 Complex64Matrix( 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 real = require( '@stdlib/complex-float32-real' );
var imag = require( '@stdlib/complex-float32-imag' );
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var Complex64Matrix = require( '@stdlib/ndarray-matrix-complex64' );

// Create a matrix containing random values:
var x = new Complex64Matrix([
    discreteUniform( 20, 0, 100 ),
    discreteUniform( 20, 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 ) {
    if ( real( v ) > 10 && imag( v ) > 10 ) {
        return v;
    }
    return new Complex64( 0.0, 0.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

• @stdlib/ndarray-matrix/float64: create a double-precision floating-point matrix (i.e., a two-dimensional ndarray).
• @stdlib/ndarray-matrix/float32: create a single-precision floating-point matrix (i.e., a two-dimensional ndarray).
• @stdlib/ndarray-matrix/int32: create a 32-bit signed integer matrix (i.e., a two-dimensional ndarray).
• @stdlib/ndarray-matrix/complex128: create a double-precision complex floating-point matrix (i.e., a two-dimensional ndarray).
• @stdlib/ndarray-matrix/ctor: create a matrix (i.e., a two-dimensional ndarray).
• @stdlib/ndarray-vector/complex64: create a single-precision complex floating-point vector (i.e., a one-dimensional ndarray).
• @stdlib/ndarray-ctor: multidimensional array constructor.

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.