Layouts

BLAS memory layouts.

Installation

npm install @stdlib/blas-base-layouts

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 layouts = require( '@stdlib/blas-base-layouts' );

layouts()

Returns a list of BLAS memory layouts.

var out = layouts();
// e.g., returns [ 'row-major', 'column-major' ]

The output array contains the following layouts:

row-major: row-major (C-style) order.
column-major: column-major (Fortran-style) order.

Examples

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

var isLayout = contains( layouts() );

var bool = isLayout( 'row-major' );
// returns true

bool = isLayout( 'column-major' );
// returns true

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

C APIs

Usage

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

STDLIB_BLAS_LAYOUT

An enumeration of BLAS memory layouts with the following fields:

STDLIB_BLAS_ROW_MAJOR: row-major (C-style) order.
STDLIB_BLAS_COLUMN_MAJOR: column-major (Fortran-style) order.

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

const enum STDLIB_BLAS_LAYOUT layout = STDLIB_BLAS_ROW_MAJOR;

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.