Skip to content

README.md

Latest commit

 

History

History
262 lines (162 loc) · 7.04 KB

README.md

File metadata and controls

262 lines (162 loc) · 7.04 KB

ctrsv

Solve one of the systems of equations A*x = b or A^T*x = b or A^H*x = b.

Usage

var ctrsv = require( '@stdlib/blas/base/ctrsv' );

ctrsv( order, uplo, trans, diag, N, A, LDA, x, sx )

Solves one of the systems of equations A*x = b, A^T*x = b, or A^H*x = b where b and x are N element vectors and A is an N by N unit, or non-unit, upper or lower triangular matrix.

var Complex64Array = require( '@stdlib/array/complex64' );

var A = new Complex64Array( [ 1.0, 0.0, 3.0, 4.0, 0.0, 0.0, 1.0, 0.0 ] );
var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );

ctrsv( 'row-major', 'upper', 'no-transpose', 'unit', 2, A, 2, x, 1 );
// x => <Complex64Array>[ 8.0, -22.0, 3.0, 4.0 ]

The function has the following parameters:

  • order: storage layout.
  • uplo: specifies whether A is an upper or lower triangular matrix.
  • trans: specifies whether A should be transposed, conjugate-transposed, or not transposed.
  • diag: specifies whether A has a unit diagonal.
  • N: number of elements along each dimension of A.
  • A: input matrix stored in linear memory as a Complex64Array.
  • LDA: stride of the first dimension of A (a.k.a., leading dimension of the matrix A).
  • x: input vector Complex64Array.
  • sx: x stride length.

The stride parameters determine how elements in the input arrays are accessed at runtime. For example, to iterate over the elements of x in reverse order,

var Complex64Array = require( '@stdlib/array/complex64' );

var A = new Complex64Array( [ 1.0, 0.0, 3.0, 4.0, 0.0, 0.0, 1.0, 0.0 ] );
var x = new Complex64Array( [ 3.0, 4.0, 1.0, 2.0 ] );

ctrsv( 'row-major', 'upper', 'no-transpose', 'unit', 2, A, 2, x, -1 );
// x => <Complex64Array>[ 3.0, 4.0, 8.0, -22.0 ]

Note that indexing is relative to the first index. To introduce an offset, use typed array views.

var Complex64Array = require( '@stdlib/array/complex64' );

// Initial arrays...
var x0 = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0 ] );
var A = new Complex64Array( [ 1.0, 0.0, 3.0, 4.0, 0.0, 0.0, 1.0, 0.0 ] );

// Create offset views...
var x1 = new Complex64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element

ctrsv( 'row-major', 'upper', 'no-transpose', 'unit', 2, A, 2, x1, 1 );
// x0 => <Complex64Array>[ 1.0, 1.0, 5.0, -19.0, 3.0, 3.0, 4.0, 4.0 ]

ctrsv.ndarray( uplo, trans, diag, N, A, sa1, sa2, oa, x, sx, ox )

Solves one of the systems of equations A*x = b or A^T*x = b or A^H*x = b, using alternative indexing semantics and where b and x are N element vectors and A is an N by N unit, or non-unit, upper or lower triangular matrix.

var Complex64Array = require( '@stdlib/array/complex64' );

var A = new Complex64Array( [ 1.0, 0.0, 3.0, 4.0, 0.0, 0.0, 1.0, 0.0 ] );
var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );

ctrsv.ndarray( 'upper', 'no-transpose', 'unit', 2, A, 2, 1, 0, x, 1, 0 );
// x => <Complex64Array>[ 8.0, -22.0, 3.0, 4.0 ]

The function has the following additional parameters:

  • sa1: stride of the first dimension of A.
  • sa2: stride of the second dimension of A.
  • oa: starting index for A.
  • ox: starting index for x.

While typed array views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example,

var Complex64Array = require( '@stdlib/array/complex64' );

var A = new Complex64Array( [ 1.0, 0.0, 3.0, 4.0, 0.0, 0.0, 1.0, 0.0 ] );
var x = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] );

ctrsv.ndarray( 'upper', 'no-transpose', 'unit', 2, A, 2, 1, 0, x, 1, 1 );
// x => <Complex64Array>[ 1.0, 1.0, 5.0, -19.0, 3.0, 3.0 ]

Notes

  • ctrsv() corresponds to the BLAS level 2 function ctrsv.
  • Neither routine tests for singularity or near-singularity. Such tests must be performed before calling the routines.

Examples

var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var Complex64Array = require( '@stdlib/array/complex64' );
var ctrsv = require( '@stdlib/blas/base/ctrsv' );

var opts = {
    'dtype': 'float32'
};

var N = 5;
var Abuf = discreteUniform( N * N * 2, -10.0, 10.0, opts );
var xbuf = discreteUniform( N * 2, -10.0, 10.0, opts );

var A = new Complex64Array( Abuf.buffer );
var x = new Complex64Array( xbuf.buffer );

ctrsv( 'column-major', 'upper', 'no-transpose', 'unit', N, A, N, x, 1 );
console.log( x );

ctrsv.ndarray( 'upper', 'no-transpose', 'unit', N, A, 1, N, 0, x, 1, 0 );
console.log( x );

C APIs

Usage

TODO

TODO

TODO.

TODO

TODO

TODO

Examples

TODO