npm package: @stdlib/lapack-base
Description: Base (i.e., lower-level) LAPACK routines.
Author: The Stdlib Authors
Latest version: 0.2.1

<!--

@license Apache-2.0

Copyright (c) 2024 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.

-->


<details>
  <summary>
    About stdlib...
  </summary>
  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
</details>

# LAPACK

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->

> Base (i.e., lower-level) linear algebra package (LAPACK) routines.

<section class="installation">

## Installation

```bash
npm install @stdlib/lapack-base
```

</section>

<section class="usage">

## Usage

```javascript
var lapack = require( '@stdlib/lapack-base' );
```

#### lapack

Namespace for "base" (i.e., lower-level) linear algebra package (LAPACK) routines.

```javascript
var o = lapack;
// returns {...}
```

The namespace contains the following:

<!-- <toc pattern="*"> -->

<div class="namespace-toc">

-   <span class="signature">[`clacgv( N, cx, strideCX )`][@stdlib/lapack/base/clacgv]</span><span class="delimiter">: </span><span class="description">conjugate each element in a single-precision complex floating-point vector.</span>
-   <span class="signature">[`clacpy( order, uplo, M, N, A, LDA, B, LDB )`][@stdlib/lapack/base/clacpy]</span><span class="delimiter">: </span><span class="description">copy all or part of a matrix `A` to another matrix `B`.</span>
-   <span class="signature">[`claset( order, uplo, M, N, alpha, beta, A, LDA )`][@stdlib/lapack/base/claset]</span><span class="delimiter">: </span><span class="description">set the off-diagonal elements and the diagonal elements of a single-precision complex floating-point matrix to specified values.</span>
-   <span class="signature">[`claswp( N, A, LDA, k1, k2, IPIV, incx )`][@stdlib/lapack/base/claswp]</span><span class="delimiter">: </span><span class="description">perform a series of row interchanges on an input matrix.</span>
-   <span class="signature">[`crot( N, cx, strideCX, cy, strideCY, c, s )`][@stdlib/lapack/base/crot]</span><span class="delimiter">: </span><span class="description">apply a plane rotation with real cosine and complex sine to a pair of single-precision complex floating-point vectors.</span>
-   <span class="signature">[`dgetrans( order, M, N, A, LDA, out, LDO )`][@stdlib/lapack/base/dge-trans]</span><span class="delimiter">: </span><span class="description">convert a matrix from row-major layout to column-major layout or vice versa.</span>
-   <span class="signature">[`dgttrf( N, DL, D, DU, DU2, IPIV )`][@stdlib/lapack/base/dgttrf]</span><span class="delimiter">: </span><span class="description">compute an `LU` factorization of a real tridiagonal matrix `A` using elimination with partial pivoting and row interchanges.</span>
-   <span class="signature">[`dlacpy( order, uplo, M, N, A, LDA, B, LDB )`][@stdlib/lapack/base/dlacpy]</span><span class="delimiter">: </span><span class="description">copy all or part of a matrix `A` to another matrix `B`.</span>
-   <span class="signature">[`dladiv( a, b, c, d, P, Q )`][@stdlib/lapack/base/dladiv]</span><span class="delimiter">: </span><span class="description">divide two double-precision complex floating-point numbers in real arithmetic.</span>
-   <span class="signature">[`dlamch( cmach )`][@stdlib/lapack/base/dlamch]</span><span class="delimiter">: </span><span class="description">determine double-precision floating-point machine parameters.</span>
-   <span class="signature">[`dlapy2( x, y )`][@stdlib/lapack/base/dlapy2]</span><span class="delimiter">: </span><span class="description">LAPACK routine to calculate `sqrt(x^2 + y^2)` in a manner which doesn't cause unnecessary overflow.</span>
-   <span class="signature">[`dlapy3( x, y, z )`][@stdlib/lapack/base/dlapy3]</span><span class="delimiter">: </span><span class="description">LAPACK routine to calculate `sqrt(x^2 + y^2 + z^2)` in a manner which doesn't cause unnecessary overflow.</span>
-   <span class="signature">[`dlarf1f( order, side, M, N, V, strideV, tau, C, LDC, work )`][@stdlib/lapack/base/dlarf1f]</span><span class="delimiter">: </span><span class="description">apply a real elementary reflector `H = I - tau * v * v^T` to a real M by N matrix `C`.</span>
-   <span class="signature">[`dlaset( order, uplo, M, N, alpha, beta, A, LDA )`][@stdlib/lapack/base/dlaset]</span><span class="delimiter">: </span><span class="description">set the off-diagonal elements and the diagonal elements of a double-precision floating-point matrix to specified values.</span>
-   <span class="signature">[`dlassq( N, X, strideX, scale, sumsq )`][@stdlib/lapack/base/dlassq]</span><span class="delimiter">: </span><span class="description">return an updated sum of squares represented in scaled form.</span>
-   <span class="signature">[`dlaswp( N, A, LDA, k1, k2, IPIV, incx )`][@stdlib/lapack/base/dlaswp]</span><span class="delimiter">: </span><span class="description">perform a series of row interchanges on an input matrix.</span>
-   <span class="signature">[`dpttrf( N, D, E )`][@stdlib/lapack/base/dpttrf]</span><span class="delimiter">: </span><span class="description">compute the `L * D * L^T` factorization of a real symmetric positive definite tridiagonal matrix `A`.</span>
-   <span class="signature">[`iladlc( order, M, N, A, LDA )`][@stdlib/lapack/base/iladlc]</span><span class="delimiter">: </span><span class="description">find the index of the last non-zero column in a matrix `A`.</span>
-   <span class="signature">[`iladlr( order, M, N, A, LDA )`][@stdlib/lapack/base/iladlr]</span><span class="delimiter">: </span><span class="description">find the index of the last non-zero row in a matrix `A`.</span>
-   <span class="signature">[`sgetrans( order, M, N, A, LDA, out, LDO )`][@stdlib/lapack/base/sge-trans]</span><span class="delimiter">: </span><span class="description">convert a matrix from row-major layout to column-major layout or vice versa.</span>
-   <span class="signature">[`slacpy( order, uplo, M, N, A, LDA, B, LDB )`][@stdlib/lapack/base/slacpy]</span><span class="delimiter">: </span><span class="description">copy all or part of a matrix `A` to another matrix `B`.</span>
-   <span class="signature">[`slaswp( N, A, LDA, k1, k2, IPIV, incx )`][@stdlib/lapack/base/slaswp]</span><span class="delimiter">: </span><span class="description">perform a series of row interchanges on an input matrix.</span>
-   <span class="signature">[`spttrf( N, D, E )`][@stdlib/lapack/base/spttrf]</span><span class="delimiter">: </span><span class="description">compute the `L * D * L^T` factorization of a real symmetric positive definite tridiagonal matrix `A`.</span>
-   <span class="signature">[`zlacgv( N, zx, strideZX )`][@stdlib/lapack/base/zlacgv]</span><span class="delimiter">: </span><span class="description">conjugate each element in a double-precision complex floating-point vector.</span>
-   <span class="signature">[`zlacpy( order, uplo, M, N, A, LDA, B, LDB )`][@stdlib/lapack/base/zlacpy]</span><span class="delimiter">: </span><span class="description">copy all or part of a matrix `A` to another matrix `B`.</span>
-   <span class="signature">[`zlaset( order, uplo, M, N, alpha, beta, A, LDA )`][@stdlib/lapack/base/zlaset]</span><span class="delimiter">: </span><span class="description">set the off-diagonal elements and the diagonal elements of a double-precision complex floating-point matrix to specified values.</span>
-   <span class="signature">[`zlaswp( N, A, LDA, k1, k2, IPIV, incx )`][@stdlib/lapack/base/zlaswp]</span><span class="delimiter">: </span><span class="description">perform a series of row interchanges on an input matrix.</span>
-   <span class="signature">[`zrot( N, zx, strideX, zy, strideY, c, s )`][@stdlib/lapack/base/zrot]</span><span class="delimiter">: </span><span class="description">apply a plane rotation with real cosine and complex sine to a pair of double-precision complex floating-point vectors.</span>

</div>

<!-- </toc> -->

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- TODO: better examples -->

<!-- eslint no-undef: "error" -->

```javascript
var objectKeys = require( '@stdlib/utils-keys' );
var lapack = require( '@stdlib/lapack-base' );

console.log( objectKeys( lapack ) );
```

</section>

<!-- /.examples -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->


<section class="main-repo" >

* * *

## Notice

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

## License

See [LICENSE][stdlib-license].


## Copyright

Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].

</section>

<!-- /.stdlib -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

[npm-image]: http://img.shields.io/npm/v/@stdlib/lapack-base.svg
[npm-url]: https://npmjs.org/package/@stdlib/lapack-base

[test-image]: https://github.com/stdlib-js/lapack-base/actions/workflows/test.yml/badge.svg?branch=v0.2.1
[test-url]: https://github.com/stdlib-js/lapack-base/actions/workflows/test.yml?query=branch:v0.2.1

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/lapack-base/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/lapack-base?branch=main

<!--

[dependencies-image]: https://img.shields.io/david/stdlib-js/lapack-base.svg
[dependencies-url]: https://david-dm.org/stdlib-js/lapack-base/main

-->

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/lapack-base/tree/deno
[deno-readme]: https://github.com/stdlib-js/lapack-base/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/lapack-base/tree/umd
[umd-readme]: https://github.com/stdlib-js/lapack-base/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/lapack-base/tree/esm
[esm-readme]: https://github.com/stdlib-js/lapack-base/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/lapack-base/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/lapack-base/main/LICENSE

<!-- <toc-links> -->

[@stdlib/lapack/base/clacgv]: https://www.npmjs.com/package/@stdlib/lapack-base-clacgv

[@stdlib/lapack/base/clacpy]: https://www.npmjs.com/package/@stdlib/lapack-base-clacpy

[@stdlib/lapack/base/claset]: https://www.npmjs.com/package/@stdlib/lapack-base-claset

[@stdlib/lapack/base/claswp]: https://www.npmjs.com/package/@stdlib/lapack-base-claswp

[@stdlib/lapack/base/crot]: https://www.npmjs.com/package/@stdlib/lapack-base-crot

[@stdlib/lapack/base/dge-trans]: https://www.npmjs.com/package/@stdlib/lapack-base-dge-trans

[@stdlib/lapack/base/dgttrf]: https://www.npmjs.com/package/@stdlib/lapack-base-dgttrf

[@stdlib/lapack/base/dlacpy]: https://www.npmjs.com/package/@stdlib/lapack-base-dlacpy

[@stdlib/lapack/base/dladiv]: https://www.npmjs.com/package/@stdlib/lapack-base-dladiv

[@stdlib/lapack/base/dlamch]: https://www.npmjs.com/package/@stdlib/lapack-base-dlamch

[@stdlib/lapack/base/dlapy2]: https://www.npmjs.com/package/@stdlib/lapack-base-dlapy2

[@stdlib/lapack/base/dlapy3]: https://www.npmjs.com/package/@stdlib/lapack-base-dlapy3

[@stdlib/lapack/base/dlarf1f]: https://www.npmjs.com/package/@stdlib/lapack-base-dlarf1f

[@stdlib/lapack/base/dlaset]: https://www.npmjs.com/package/@stdlib/lapack-base-dlaset

[@stdlib/lapack/base/dlassq]: https://www.npmjs.com/package/@stdlib/lapack-base-dlassq

[@stdlib/lapack/base/dlaswp]: https://www.npmjs.com/package/@stdlib/lapack-base-dlaswp

[@stdlib/lapack/base/dpttrf]: https://www.npmjs.com/package/@stdlib/lapack-base-dpttrf

[@stdlib/lapack/base/iladlc]: https://www.npmjs.com/package/@stdlib/lapack-base-iladlc

[@stdlib/lapack/base/iladlr]: https://www.npmjs.com/package/@stdlib/lapack-base-iladlr

[@stdlib/lapack/base/sge-trans]: https://www.npmjs.com/package/@stdlib/lapack-base-sge-trans

[@stdlib/lapack/base/slacpy]: https://www.npmjs.com/package/@stdlib/lapack-base-slacpy

[@stdlib/lapack/base/slaswp]: https://www.npmjs.com/package/@stdlib/lapack-base-slaswp

[@stdlib/lapack/base/spttrf]: https://www.npmjs.com/package/@stdlib/lapack-base-spttrf

[@stdlib/lapack/base/zlacgv]: https://www.npmjs.com/package/@stdlib/lapack-base-zlacgv

[@stdlib/lapack/base/zlacpy]: https://www.npmjs.com/package/@stdlib/lapack-base-zlacpy

[@stdlib/lapack/base/zlaset]: https://www.npmjs.com/package/@stdlib/lapack-base-zlaset

[@stdlib/lapack/base/zlaswp]: https://www.npmjs.com/package/@stdlib/lapack-base-zlaswp

[@stdlib/lapack/base/zrot]: https://www.npmjs.com/package/@stdlib/lapack-base-zrot

<!-- </toc-links> -->

</section>

<!-- /.links -->