Auto-generated commit

base/flipud3d/README.md

@@ -0,0 +1,110 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2023 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.
+
+-->
+
+# flipud3d
+
+> Reverse the order of elements along the second-to-last dimension of a three-dimensional nested input array.
+
+<!-- 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 -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var flipud3d = require( '@stdlib/array/base/flipud3d' );
+```
+
+#### flipud3d( x )
+
+Reverses the order of elements along the second-to-last dimension of a three-dimensional nested input array.
+
+```javascript
+var out = flipud3d( [ [ [ 1, 2 ], [ 3, 4 ] ] ] );
+// returns [ [ [ 3, 4 ], [ 1, 2 ] ] ]
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var filled3dBy = require( '@stdlib/array/base/filled3d-by' );
+var flipud3d = require( '@stdlib/array/base/flipud3d' );
+
+var x = filled3dBy( [ 3, 3, 3 ], discreteUniform( -50, 50 ) );
+console.log( x );
+
+var y = flipud3d( x );
+console.log( y );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- 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">
+
+</section>
+
+<!-- /.links -->

base/flipud3d/benchmark/benchmark.size.js

@@ -0,0 +1,110 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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/base/uniform' ).factory;
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var floor = require( '@stdlib/math/base/special/floor' );
+var filled3dBy = require( './../../../base/filled3d-by' );
+var numel = require( '@stdlib/ndarray/base/numel' );
+var pkg = require( './../package.json' ).name;
+var flipud3d = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveIntegerArray} shape - array shape
+* @returns {Function} benchmark function
+*/
+function createBenchmark( shape ) {
+	var x = filled3dBy( shape, uniform( -100.0, 100.0 ) );
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var i0;
+		var i1;
+		var i2;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = flipud3d( x );
+			i2 = i % shape[ 0 ];
+			i1 = i % shape[ 1 ];
+			i0 = i % shape[ 2 ];
+			if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+
+		i2 = i % shape[ 0 ];
+		i1 = i % shape[ 1 ];
+		i0 = i % shape[ 2 ];
+		if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var min;
+	var max;
+	var sh;
+	var N;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		N = floor( pow( pow( 10, i ), 1.0/3.0 ) );
+		sh = [ N, N, N ];
+		f = createBenchmark( sh );
+		bench( pkg+'::equidimensional:size='+numel( sh ), f );
+	}
+}
+
+main();

base/flipud3d/docs/repl.txt

@@ -0,0 +1,25 @@
+
+{{alias}}( x )
+    Reverses the order of elements along the second-to-last dimension of a
+    three-dimensional nested input array.
+
+    The function does *not* perform a deep copy of nested array elements.
+
+    Parameters
+    ----------
+    x: ArrayLikeObject
+        Input nested array.
+
+    Returns
+    -------
+    out: Array
+        Output array.
+
+    Examples
+    --------
+    > var out = {{alias}}( [ [ [ 1, 2 ], [ 3, 4 ] ] ] )
+    [ [ [ 3, 4 ], [ 1, 2 ] ] ]
+
+    See Also
+    --------
+

base/flipud3d/docs/types/index.d.ts

@@ -0,0 +1,46 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 { Array3D } from '@stdlib/types/array';
+
+/**
+* Reverses the order of elements along the second-to-last dimension of a three-dimensional nested input array.
+*
+* ## Notes
+*
+* -   The function does **not** perform a deep copy of nested array elements.
+*
+* @param x - input nested array
+* @returns output array
+*
+* @example
+* var x = [ [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] ];
+*
+* var out = flipud3d( x );
+* // returns [ [ [ 5, 6 ], [ 3, 4 ], [ 1, 2 ] ] ]
+*/
+declare function flipud3d<T = unknown>( x: Array3D<T> ): Array3D<T>;
+
+
+// EXPORTS //
+
+export = flipud3d;

base/flipud3d/docs/types/test.ts

@@ -0,0 +1,48 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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.
+*/
+
+import flipud3d = require( './index' );
+
+
+// TESTS //
+
+// The function returns a nested array...
+{
+	const x = [ [ [ 1, 2 ], [ 3, 4 ] ] ];
+
+	flipud3d( x ); // $ExpectType Array3D<number>
+}
+
+// The compiler throws an error if the function is provided a first argument which is not a nested array...
+{
+	flipud3d( 'abc' ); // $ExpectError
+	flipud3d( 1 ); // $ExpectError
+	flipud3d( true ); // $ExpectError
+	flipud3d( false ); // $ExpectError
+	flipud3d( null ); // $ExpectError
+	flipud3d( {} ); // $ExpectError
+	flipud3d( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	const x = [ [ [ 1, 2 ], [ 3, 4 ] ] ];
+
+	flipud3d(); // $ExpectError
+	flipud3d( x, 2 ); // $ExpectError
+}

base/flipud3d/examples/index.js

@@ -0,0 +1,29 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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';
+
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
+var filled3dBy = require( './../../../base/filled3d-by' );
+var flipud3d = require( './../lib' );
+
+var x = filled3dBy( [ 3, 3, 3 ], discreteUniform( -50, 50 ) );
+console.log( x );
+
+var y = flipud3d( x );
+console.log( y );