Skip to content
Prev Previous commit
Next Next commit
docs: add types and types tests
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
  • Loading branch information
DivitJain26 committed May 10, 2026
commit 8b636b1d175bca41d029ae7d9e3c04b10133cbd2
117 changes: 117 additions & 0 deletions lib/node_modules/@stdlib/blas/base/ctpsv/docs/types/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 4.1

/// <reference types="@stdlib/types"/>

import { Layout, MatrixTriangle, TransposeOperation, DiagonalType } from '@stdlib/types/blas';
import { Complex64Array } from '@stdlib/types/array';

/**
* Interface describing `ctpsv`.
*/
interface Routine {
/**
* Solves one of the systems of equations `A*x = b` or `A^T*x = b` or `A^H*x = b`, where `b` and `x` are `N` element vector and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix, supplied in packed form.
*
* @param order - storage layout
* @param uplo - specifies whether `A` is an upper or lower triangular matrix
* @param trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
* @param diag - specifies whether `A` has a unit diagonal
* @param N - number of elements along each dimension in the matrix `A`
* @param AP - packed form of a symmetric matrix `A`
* @param x - input vector
* @param strideX - `x` stride length
* @returns `x`
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
*
* var AP = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0, 3.0, 3.0, 5.0, 5.0, 6.0, 6.0 ] );
* var x = new Complex64Array( [ 0.0, 2.0, 0.0, 20.0, 0.0, 62.0 ] );
*
* ctpsv( 'row-major', 'lower', 'no-transpose', 'non-unit', 3, AP, x, 1 );
* // x => <Complex64Array>[ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ]
*/
( order: Layout, uplo: MatrixTriangle, trans: TransposeOperation, diag: DiagonalType, N: number, AP: Complex64Array, x: Complex64Array, strideX: number ): Complex64Array;

/**
* 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 vector and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix, supplied in packed form.
*
* @param uplo - specifies whether `A` is an upper or lower triangular matrix
* @param trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
* @param diag - specifies whether `A` has a unit diagonal
* @param N - number of elements along each dimension in the matrix `A`
* @param AP - packed form of a symmetric matrix `A`
* @param strideAP - `AP` stride length
* @param offsetAP - starting index for `AP`
* @param x - input vector
* @param strideX - `x` stride length
* @param offsetX - starting index for `x`
* @returns `x`
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
*
* var AP = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0, 3.0, 3.0, 5.0, 5.0, 6.0, 6.0 ] );
* var x = new Complex64Array( [ 0.0, 2.0, 0.0, 20.0, 0.0, 62.0 ] );
*
* ctpsv.ndarray( 'row-major', 'lower', 'no-transpose', 'non-unit', 3, AP, 1, 0, x, 1, 0 );
* // x => <Complex64Array>[ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ]
*/
ndarray( order: Layout, uplo: MatrixTriangle, trans: TransposeOperation, diag: DiagonalType, N: number, AP: Complex64Array, strideAP: number, offsetAP: number, x: Complex64Array, strideX: number, offsetX: number ): Complex64Array;
}

/**
* Solves one of the systems of equations `A*x = b` or `A^T*x = b` or `A^H*x = b`, where `b` and `x` are `N` element vector and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix, supplied in packed form.
*
* @param order - storage layout
* @param uplo - specifies whether `A` is an upper or lower triangular matrix
* @param trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
* @param diag - specifies whether `A` has a unit diagonal
* @param N - number of elements along each dimension in the matrix `A`
* @param AP - packed form of a symmetric matrix `A`
* @param x - input vector
* @param strideX - `x` stride length
* @returns `x`
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
*
* var AP = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0, 3.0, 3.0, 5.0, 5.0, 6.0, 6.0 ] );
* var x = new Complex64Array( [ 0.0, 2.0, 0.0, 20.0, 0.0, 62.0 ] );
*
* ctpsv( 'row-major', 'lower', 'no-transpose', 'non-unit', 3, AP, x, 1 );
* // x => <Complex64Array>[ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ]
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
*
* var AP = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0, 3.0, 3.0, 5.0, 5.0, 6.0, 6.0 ] );
* var x = new Complex64Array( [ 0.0, 2.0, 0.0, 20.0, 0.0, 62.0 ] );
*
* ctpsv.ndarray( 'row-major', 'lower', 'no-transpose', 'non-unit', 3, AP, 1, 0, x, 1, 0 );
* // x => <Complex64Array>[ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ]
*/
declare var ctpsv: Routine;


// EXPORTS //

export = ctpsv;
Loading