feat: add lapack/base/dpotf2

lib/node_modules/@stdlib/lapack/base/dpotf2/README.md

@@ -0,0 +1,242 @@
+<!--
+
+@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.
+
+-->
+
+# dpotf2
+
+> Compute the Cholesky factorization of a real symmetric positive definite matrix `A`.
+
+<section class = "usage">
+
+## Usage
+
+```javascript
+var dpotf2 = require( '@stdlib/lapack/base/dpotf2' );
+```
+
+#### dpotf2( order, uplo, N, A, LDA )
+
+Computes the Cholesky factorization of a real symmetric positive definite matrix `A`.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var A = new Float64Array( [ 1.0, 0.0, 0.0, 4.0 ] );
+
+var out = dpotf2( 'row-major', 'upper', 2, A, 2 );
+// returns 0
+```
+
+The function has the following parameters:
+
+-   **order**: storage layout.
+-   **uplo**: specifies whether to copy the upper or lower triangular/trapezoidal part of matrix `A`.
+-   **N**: order of matrix `A`.
+-   **A**: input symmetric positive definite [`Float64Array`][mdn-float64array].
+-   **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
+
+Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
+
+<!-- eslint-disable stdlib/capitalized-comments -->
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+// Initial arrays...
+var A0 = new Float64Array( [ 0.0, 1.0, 0.0, 0.0, 4.0 ] );
+
+// Create offset views...
+var A1 = new Float64Array( A0.buffer, A0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+
+var out = dpotf2( 'row-major', 'upper', 2, A1, 2 );
+// returns 0
+```
+
+#### dpotf2.ndarray( uplo, N, A, strideA1, strideA2, offsetA )
+
+Computes the Cholesky factorization of a real symmetric positive definite matrix `A` using alternative semantic indexing.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var A = new Float64Array( [ 1.0, 0.0, 0.0, 4.0 ] );
+
+var out = dpotf2.ndarray( 'upper', 2, A, 2, 1, 0 );
+// returns 0
+```
+
+The function has the following parameters:
+
+-   **uplo**: specifies whether to copy the upper or lower triangular/trapezoidal part of matrix `A`.
+-   **N**: order of matrix `A`.
+-   **A**: input symmetric positive definite [`Float64Array`][mdn-float64array].
+-   **strideA1**: stride of the first dimension of `A`.
+-   **strideA2**: stride of the second dimension of `A`.
+-   **offsetA**: starting index for `A`.
+
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example,
+
+<!-- eslint-disable max-len -->
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+var A = new Float64Array( [ 0.0, 1.0, 0.0, 0.0, 4.0 ] );
+
+var out = dpotf2.ndarray( 'upper', 2, A, 2, 1, 1 );
+// returns 0
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   Both functions mutate the input array `A`.
+
+-   Both functions return a status code indicating success or failure. A status code indicates the following conditions:
+
+    -   `0`: factorization was successful.
+    -   `<0`: the k-th argument had an illegal value, where `-k` equals the status code value.
+    -   `0 < k < N`: the leading principal minor of order `k` is not positive and factorization could not be completed, where `k` equals the status code value.
+    -   `N`: the leading principal minor of order `N` is not positive, and factorization was completed.
+
+-   `dpotf2()` corresponds to the [LAPACK][LAPACK] routine [`dpotf2`][lapack-dpotf2].
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+var dpotf2 = require( '@stdlib/lapack/base/dpotf2' );
+
+var A = new Float64Array( [ 1.0, 0.0, 0.0, 4.0 ] );
+
+var out = dpotf2( 'row-major', 'upper', 2, A, 2 );
+console.log( A );
+console.log( out );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+TODO
+```
+
+#### TODO
+
+TODO.
+
+```c
+TODO
+```
+
+TODO
+
+```c
+TODO
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+TODO
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<!-- 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="links">
+
+[lapack]: https://www.netlib.org/lapack/explore-html/
+
+[lapack-dpotf2]: https://www.netlib.org/lapack/explore-html/de/db9/group__potf2_gac3e7c9b72833e5467d91259ce0d0d4d4.html#gac3e7c9b72833e5467d91259ce0d0d4d4
+
+[mdn-float64array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array
+
+[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/lapack/base/dpotf2/benchmark/benchmark.js

@@ -0,0 +1,96 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var pkg = require( './../package.json' ).name;
+var dpotf2 = require( './../lib/dpotf2.js' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'float64'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var A = uniform( len, 1.0, 100.0, options );
+	return benchmark;
+
+	function benchmark( b ) {
+		var d;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			d = dpotf2( 'row-major', 'upper', len, A, len );
+			if ( isnan( d ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnan( d ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':len='+len, f );
+	}
+}
+
+main();