feat!: remove order argument from ndarray method

This commit removes the `order` argument, as this argument is not
necessary when providing multiple strides. The layout is conveyed
by the strides, not the order string, and requiring that both
strides and an order string be provided allows for the potential
for conflicting information (e.g., an order string of "row-major",
while the strides are in "column-major" order due to taking the
transpose, etc). In short, the strides are the source of truth.

BREAKING CHANGE: remove `order` argument from `ndarray` method

To migrate, users should drop the `order` argument when invoking
the `ndarray` method.

Author: kgryte

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

@@ -102,7 +102,7 @@ dlaswp( 'row-major', 2, A1, 2, 0, 2, IPIV1, 1 );
 // A0 => <Float64Array>[ 0.0, 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
 ```
 
-#### dlaswp.ndarray( order, N, A, sa1, sa2, oa, k1, k2, inck, IPIV, si, oi )
+#### dlaswp.ndarray( N, A, sa1, sa2, oa, k1, k2, inck, IPIV, si, oi )
 
 Performs a series of row interchanges on the matrix `A` using pivot indices stored in `IPIV` and alternative indexing semantics.
 
@@ -113,13 +113,12 @@ var Float64Array = require( '@stdlib/array/float64' );
 var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 var IPIV = new Int32Array( [ 2, 0, 1 ] );
 
-dlaswp.ndarray( 'row-major', 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
+dlaswp.ndarray( 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
 // A => <Float64Array>[ 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
 ```
 
 The function has the following additional parameters:
 
--   **order**: storage layout.
 -   **N**: number of columns in `A`.
 -   **A**: input matrix stored in linear memory as a [`Float64Array`][mdn-float64array].
 -   **sa1**: stride of the first dimension of `A`.
@@ -143,7 +142,7 @@ var Float64Array = require( '@stdlib/array/float64' );
 var A = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
 var IPIV = new Int32Array( [ 0, 0, 2, 0, 1 ] );
 
-dlaswp.ndarray( 'row-major', 2, A, 2, 1, 4, 0, 2, 1, IPIV, 1, 2 );
+dlaswp.ndarray( 2, A, 2, 1, 4, 0, 2, 1, IPIV, 1, 2 );
 // A => <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
 ```
 

lib/node_modules/@stdlib/lapack/base/dlaswp/benchmark/benchmark.ndarray.js

@@ -82,7 +82,7 @@ function createBenchmark( order, N, nrows ) {
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
-			z = dlaswp( order, N, A, sa1, sa2, 0, 0, nrows-1, 1, IPIV, 1, 0 );
+			z = dlaswp( N, A, sa1, sa2, 0, 0, nrows-1, 1, IPIV, 1, 0 );
 			if ( isnan( z[ i%z.length ] ) ) {
 				b.fail( 'should not return NaN' );
 			}

lib/node_modules/@stdlib/lapack/base/dlaswp/docs/repl.txt

@@ -59,7 +59,7 @@
     <Float64Array>[ 0.0, 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
 
 
-{{alias}}.ndarray( order, N, A, sa1, sa2, oa, k1, k2, inck, IPIV, si, oi )
+{{alias}}.ndarray( N, A, sa1, sa2, oa, k1, k2, inck, IPIV, si, oi )
     Performs a series of row interchanges on the matrix `A` using pivot indices
     stored in `IPIV` and alternative indexing semantics.
 
@@ -69,10 +69,6 @@
 
     Parameters
     ----------
-    order: string
-        Row-major (C-style) or column-major (Fortran-style) order. Must be
-        either 'row-major' or 'column-major'.
-
     N: integer
         Number of columns in `A`.
 
@@ -116,8 +112,7 @@
     --------
     > var IPIV = new {{alias:@stdlib/array/int32}}( [ 2, 0, 1 ] );
     > var A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
-    > var ord = 'row-major';
-    > {{alias}}.ndarray( ord, 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 )
+    > {{alias}}.ndarray( 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 )
     <Float64Array>[ 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
 
     See Also

lib/node_modules/@stdlib/lapack/base/dlaswp/docs/types/index.d.ts

@@ -54,7 +54,6 @@ interface Routine {
 	/**
 	* Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV` and alternative indexing semantics.
 	*
-	* @param order - storage layout
 	* @param N - number of columns in `A`
 	* @param A - input matrix
 	* @param strideA1 - stride of the first dimension of `A`
@@ -75,10 +74,10 @@ interface Routine {
 	* var IPIV = new Int32Array( [ 2, 0, 1 ] );
 	* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 	*
-	* dlaswp.ndarray( 'row-major', 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
+	* dlaswp.ndarray( 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
 	* // A => <Float64Array>[ 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
 	*/
-	ndarray( order: Layout, N: number, A: Float64Array, strideA1: number, strideA2: number, offsetA: number, k1: number, k2: number, inck: number, IPIV: Int32Array, strideIPIV: number, offsetIPIV: number ): Float64Array;
+	ndarray( N: number, A: Float64Array, strideA1: number, strideA2: number, offsetA: number, k1: number, k2: number, inck: number, IPIV: Int32Array, strideIPIV: number, offsetIPIV: number ): Float64Array;
 }
 
 /**
@@ -111,7 +110,7 @@ interface Routine {
 * var IPIV = new Int32Array( [ 2, 0, 1 ] );
 * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 *
-* dlaswp.ndarray( 'row-major', 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
+* dlaswp.ndarray( 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
 * // A => <Float64Array>[ 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
 */
 declare var dlaswp: Routine;

lib/node_modules/@stdlib/lapack/base/dlaswp/docs/types/test.ts

@@ -20,6 +20,7 @@
 
 // MODULES //
 
+var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major' );
 var floor = require( '@stdlib/math/base/special/floor' );
 var dswap = require( '@stdlib/blas/base/dswap' ).ndarray;
 
@@ -35,7 +36,6 @@ var BLOCK_SIZE = 32;
 * Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV`.
 *
 * @private
-* @param {string} order - storage layout
 * @param {PositiveInteger} N - number of columns in `A`
 * @param {Float64Array} A - input matrix
 * @param {integer} strideA1 - stride of the first dimension of `A`
@@ -56,10 +56,10 @@ var BLOCK_SIZE = 32;
 * var IPIV = new Int32Array( [ 2, 0, 1 ] );
 * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 *
-* dlaswp( 'row-major', 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
+* dlaswp( 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
 * // A => <Float64Array>[ 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
 */
-function dlaswp( order, N, A, strideA1, strideA2, offsetA, k1, k2, inck, IPIV, strideIPIV, offsetIPIV ) { // eslint-disable-line max-len, max-params
+function dlaswp( N, A, strideA1, strideA2, offsetA, k1, k2, inck, IPIV, strideIPIV, offsetIPIV ) { // eslint-disable-line max-len, max-params
 	var nrows;
 	var n32;
 	var tmp;
@@ -82,7 +82,7 @@ function dlaswp( order, N, A, strideA1, strideA2, offsetA, k1, k2, inck, IPIV, s
 	nrows += 1;
 
 	// If the order is row-major, we can delegate to the Level 1 routine `dswap` for interchanging rows...
-	if ( order === 'row-major' ) {
+	if ( isRowMajor( [ strideA1, strideA2 ] ) ) {
 		ip = offsetIPIV;
 		for ( i = 0, k = k1; i < nrows; i++, k += inck ) {
 			row = IPIV[ ip ];

lib/node_modules/@stdlib/lapack/base/dlaswp/lib/base.js

@@ -84,7 +84,7 @@ function dlaswp( order, N, A, LDA, k1, k2, IPIV, incx ) {
 		sa1 = LDA;
 		sa2 = 1;
 	}
-	return base( order, N, A, sa1, sa2, 0, k1, k2, inc, IPIV, incx, io );
+	return base( N, A, sa1, sa2, 0, k1, k2, inc, IPIV, incx, io );
 }
 
 

lib/node_modules/@stdlib/lapack/base/dlaswp/lib/dlaswp.js

@@ -20,8 +20,6 @@
 
 // MODULES //
 
-var isLayout = require( '@stdlib/blas/base/assert/is-layout' );
-var format = require( '@stdlib/string/format' );
 var base = require( './base.js' );
 
 
@@ -30,7 +28,6 @@ var base = require( './base.js' );
 /**
 * Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV`.
 *
-* @param {string} order - storage layout
 * @param {PositiveInteger} N - number of columns in `A`
 * @param {Float64Array} A - input matrix
 * @param {integer} strideA1 - stride of the first dimension of `A`
@@ -42,7 +39,6 @@ var base = require( './base.js' );
 * @param {Int32Array} IPIV - vector of pivot indices
 * @param {integer} strideIPIV - `IPIV` stride length
 * @param {NonNegativeInteger} offsetIPIV - index offset for `IPIV`
-* @throws {TypeError} first argument must be a valid order
 * @returns {Float64Array} permuted matrix `A`
 *
 * @example
@@ -52,14 +48,11 @@ var base = require( './base.js' );
 * var IPIV = new Int32Array( [ 2, 0, 1 ] );
 * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 *
-* dlaswp( 'row-major', 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
+* dlaswp( 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
 * // A => <Float64Array>[ 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
 */
-function dlaswp( order, N, A, strideA1, strideA2, offsetA, k1, k2, inck, IPIV, strideIPIV, offsetIPIV ) { // eslint-disable-line max-len, max-params
+function dlaswp( N, A, strideA1, strideA2, offsetA, k1, k2, inck, IPIV, strideIPIV, offsetIPIV ) { // eslint-disable-line max-len, max-params
 	var tmp;
-	if ( !isLayout( order ) ) {
-		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
-	}
 	if ( inck < 0 ) {
 		offsetIPIV += k2 * strideIPIV;
 		strideIPIV *= -1;
@@ -71,7 +64,7 @@ function dlaswp( order, N, A, strideA1, strideA2, offsetA, k1, k2, inck, IPIV, s
 		offsetIPIV += k1 * strideIPIV;
 		inck = 1;
 	}
-	return base( order, N, A, strideA1, strideA2, offsetA, k1, k2, inck, IPIV, strideIPIV, offsetIPIV ); // eslint-disable-line max-len
+	return base( N, A, strideA1, strideA2, offsetA, k1, k2, inck, IPIV, strideIPIV, offsetIPIV ); // eslint-disable-line max-len
 }