Triangular Parts

BLAS matrix triangles.

Installation

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

Usage

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

matrixTriangles()

Returns a list of BLAS matrix triangles.

var out = matrixTriangles();
// e.g., returns [ 'upper', 'lower' ]

The output array contains the following types:

• upper: upper triangular part of a matrix.
• lower: lower triangular part of a matrix.

Examples

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

var isMatrixTriangle = contains( matrixTriangles() );

var bool = isMatrixTriangle( 'lower' );
// returns true

bool = isMatrixTriangle( 'upper' );
// returns true

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

C APIs

Usage

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

STDLIB_BLAS_MATRIX_TRIANGLE

An enumeration of BLAS matrix triangles with the following fields:

• STDLIB_BLAS_UPPER: upper triangular part of a matrix.
• STDLIB_BLAS_LOWER: lower triangular part of a matrix.

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

const enum STDLIB_BLAS_MATRIX_TRIANGLE v = STDLIB_BLAS_LOWER;

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-2024. The Stdlib Authors.