Matrix Orientations

BLAS matrix orientations.

Installation

npm install @stdlib/blas-base-matrix-orientations

Usage

var orientations = require( '@stdlib/blas-base-matrix-orientations' );

orientations()

Returns a list of matrix orientations.

var out = orientations();
// e.g., returns [ 'rows', 'columns' ]

The output array contains the following types:

• rows: data is stored along matrix rows.
• columns: data is stored along matrix columns.

Examples

var contains = require( '@stdlib/array-base-assert-contains' ).factory;
var orientations = require( '@stdlib/blas-base-matrix-orientations' );

var isMatrixOrientation = contains( orientations() );

var bool = isMatrixOrientation( 'rows' );
// returns true

bool = isMatrixOrientation( 'columns' );
// returns true

bool = isMatrixOrientation( 'beep' );
// returns false

C APIs

Usage

#include "stdlib/blas/base/matrix_orientations.h"

STDLIB_BLAS_MATRIX_ORIENTATION

An enumeration of matrix orientations with the following fields:

• STDLIB_BLAS_ROW_MATRIX: data is stored along matrix rows.
• STDLIB_BLAS_COLUMN_MATRIX: data is stored along matrix columns.

#include "stdlib/blas/base/matrix_orientations.h"

const enum STDLIB_BLAS_MATRIX_ORIENTATION v = STDLIB_BLAS_ROW_MATRIX;

Notes

• Enumeration constants should be considered opaque values, and one should not rely on specific integer values.

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.