-
-
Notifications
You must be signed in to change notification settings - Fork 834
feat: add lapack/base/iladlc
#7083
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
9e8d0f6
feat: add base implementation
aayush0325 54aca86
feat: add exports
aayush0325 74817d9
test: add fixtures
aayush0325 a870958
test: write all tests
aayush0325 08aa12a
bench: add benchmarks
aayush0325 3422a64
docs: add README
aayush0325 8afe288
docs: add docs folder
aayush0325 47962d4
Merge remote-tracking branch 'upstream/develop' into lapack-iladlc
stdlib-bot 076d95a
chore: cleanup
aayush0325 7b52be7
chore: cleaning up
aayush0325 35434a0
docs: add column-major example
kgryte 2231950
refactor: use 'fast' max
kgryte c4e471b
docs: remove notes
kgryte File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,259 @@ | ||
<!-- | ||
|
||
@license Apache-2.0 | ||
|
||
Copyright (c) 2025 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. | ||
|
||
--> | ||
|
||
# iladlc | ||
|
||
> Find the index of the last non-zero column in a matrix `A`. | ||
|
||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var iladlc = require( '@stdlib/lapack/base/iladlc' ); | ||
``` | ||
|
||
#### iladlc( order, M, N, A, LDA ) | ||
|
||
Returns the index of the last non-zero column in a matrix `A`. | ||
|
||
```javascript | ||
var Float64Array = require( '@stdlib/array/float64' ); | ||
|
||
var A = new Float64Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] ); | ||
|
||
/* | ||
A = [ | ||
[ 1.0, 2.0, 0.0 ], | ||
[ 3.0, 4.0, 0.0 ] | ||
] | ||
*/ | ||
|
||
var out = iladlc( 'row-major', 2, 3, A, 3 ); | ||
// returns 1 | ||
``` | ||
|
||
The function has the following parameters: | ||
|
||
- **order**: storage layout. | ||
- **M**: number of rows in `A`. | ||
- **N**: number of columns in `A`. | ||
- **A**: input [`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 array: | ||
var A0 = new Float64Array( [ 9999.0, 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] ); | ||
|
||
// Create an offset view: | ||
var A1 = new Float64Array( A0.buffer, A0.BYTES_PER_ELEMENT*1 ); // start at 2nd element | ||
|
||
var out = iladlc( 'row-major', 2, 3, A1, 3 ); | ||
// returns 1 | ||
``` | ||
|
||
#### iladlc.ndarray( M, N, A, strideA1, strideA2, offsetA ) | ||
|
||
Returns the index of the last non-zero column in a matrix `A` using alternative indexing semantics. | ||
|
||
```javascript | ||
var Float64Array = require( '@stdlib/array/float64' ); | ||
|
||
var A = new Float64Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] ); | ||
|
||
/* | ||
A = [ | ||
[ 1.0, 2.0, 0.0 ], | ||
[ 3.0, 4.0, 0.0 ] | ||
] | ||
*/ | ||
|
||
var out = iladlc.ndarray( 2, 3, A, 3, 1, 0 ); | ||
// returns 1 | ||
``` | ||
|
||
The function has the following parameters: | ||
|
||
- **M**: number of rows in `A`. | ||
- **N**: number of columns in `A`. | ||
- **A**: input [`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 parameter supports indexing semantics based on a starting index. For example, | ||
|
||
```javascript | ||
var Float64Array = require( '@stdlib/array/float64' ); | ||
|
||
var A = new Float64Array( [ 9999.0, 1.0, 2.0, 0.0, 3.0, 4.0, 0.0 ] ); | ||
|
||
/* | ||
A = [ | ||
[ 1.0, 2.0, 0.0 ], | ||
[ 3.0, 4.0, 0.0 ] | ||
] | ||
*/ | ||
|
||
var out = iladlc.ndarray( 2, 3, A, 3, 1, 1 ); | ||
// returns 1 | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<section class="notes"> | ||
|
||
## Notes | ||
|
||
- This routine is commonly used throughout LAPACK to shrink work domains (e.g., before bulge-chasing, deflation, or when trimming Householder panels), thus ensuring that higher-level routines operate only on numerically relevant sub-matrices. | ||
- `iladlc()` corresponds to the [LAPACK][lapack] routine [`iladlc`][lapack-iladlc]. | ||
|
||
</section> | ||
|
||
<!-- /.notes --> | ||
|
||
<section class="examples"> | ||
|
||
## Examples | ||
|
||
<!-- eslint no-undef: "error" --> | ||
|
||
```javascript | ||
var ndarray2array = require( '@stdlib/ndarray/base/to-array' ); | ||
var Float64Array = require( '@stdlib/array/float64' ); | ||
var shape2strides = require( '@stdlib/ndarray/base/shape2strides' ); | ||
var iladlc = require( '@stdlib/lapack/base/iladlc' ); | ||
|
||
var shape = [ 3, 3 ]; | ||
var order = 'row-major'; | ||
var strides = shape2strides( shape, order ); | ||
|
||
var A = new Float64Array( [ 1.0, 2.0, 0.0, 3.0, 4.0, 0.0, 5.0, 6.0, 0.0 ] ); | ||
console.log( ndarray2array( A, shape, strides, 0, order ) ); | ||
|
||
var out = iladlc( order, shape[ 0 ], shape[ 1 ], A, strides[ 0 ] ); | ||
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-iladlc]: https://www.netlib.org/lapack/explore-html-3.6.1/d7/d43/group__aux_o_t_h_e_rauxiliary_gab8b3783390380038c9d26de61d7aefb4.html | ||
|
||
[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 --> |
111 changes: 111 additions & 0 deletions
111
lib/node_modules/@stdlib/lapack/base/iladlc/benchmark/benchmark.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,111 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2025 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 isnan = require( '@stdlib/math/base/assert/is-nan' ); | ||
var zeros = require( '@stdlib/array/zeros' ); | ||
var pow = require( '@stdlib/math/base/special/pow' ); | ||
var floor = require( '@stdlib/math/base/special/floor' ); | ||
var pkg = require( './../package.json' ).name; | ||
var iladlc = require( './../lib/iladlc.js' ); | ||
|
||
|
||
// VARIABLES // | ||
|
||
var LAYOUTS = [ | ||
'row-major', | ||
'column-major' | ||
]; | ||
|
||
|
||
// FUNCTIONS // | ||
|
||
/** | ||
* Creates a benchmark function. | ||
* | ||
* @private | ||
* @param {string} order - storage layout | ||
* @param {PositiveInteger} N - number of elements along each dimension | ||
* @returns {Function} benchmark function | ||
*/ | ||
function createBenchmark( order, N ) { | ||
var A = zeros( N*N, 'float64' ); | ||
return benchmark; | ||
|
||
/** | ||
* Benchmark function. | ||
* | ||
* @private | ||
* @param {Benchmark} b - benchmark instance | ||
*/ | ||
function benchmark( b ) { | ||
var z; | ||
var i; | ||
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
kgryte marked this conversation as resolved.
Show resolved
Hide resolved
|
||
A[ 0 ] = i; | ||
z = iladlc( order, N, N, A, N ); | ||
kgryte marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if ( isnan( z ) ) { | ||
b.fail( 'should not return NaN' ); | ||
kgryte marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
} | ||
b.toc(); | ||
if ( isnan( z ) ) { | ||
b.fail( 'should not return NaN' ); | ||
} | ||
b.pass( 'benchmark finished' ); | ||
b.end(); | ||
} | ||
} | ||
|
||
|
||
// MAIN // | ||
|
||
/** | ||
* Main execution sequence. | ||
* | ||
* @private | ||
*/ | ||
function main() { | ||
var min; | ||
var max; | ||
var ord; | ||
var N; | ||
var f; | ||
var i; | ||
var k; | ||
|
||
min = 1; // 10^min | ||
max = 6; // 10^max | ||
|
||
for ( k = 0; k < LAYOUTS.length; k++ ) { | ||
ord = LAYOUTS[ k ]; | ||
for ( i = min; i <= max; i++ ) { | ||
N = floor( pow( pow( 10, i ), 1.0/2.0 ) ); | ||
f = createBenchmark( ord, N ); | ||
bench( pkg+'::square_matrix:order='+ord+',size='+(N*N), f ); | ||
} | ||
} | ||
} | ||
|
||
main(); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.