@stdlib/array-base-flatten5d 0.0.1

package/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/NOTICE

@@ -0,0 +1 @@
+Copyright (c) 2016-2023 The Stdlib Authors.

package/README.md

@@ -0,0 +1,244 @@
+<!--
+
+@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.
+
+-->
+
+# flatten5d
+
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
+
+> Flatten a five-dimensional nested array.
+
+<section class="installation">
+
+## Installation
+
+```bash
+npm install @stdlib/array-base-flatten5d
+```
+
+</section>
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var flatten5d = require( '@stdlib/array-base-flatten5d' );
+```
+
+#### flatten5d( x, shape, colexicographic )
+
+Flattens a five-dimensional nested array.
+
+```javascript
+var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+
+var out = flatten5d( x, [ 2, 1, 1, 1, 2 ], false );
+// returns [ 1, 2, 3, 4 ]
+```
+
+To flatten in colexicographic order, provide a third argument equal to `true`.
+
+```javascript
+var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+
+var out = flatten5d( x, [ 2, 1, 1, 1, 2 ], true );
+// returns [ 1, 3, 2, 4 ]
+```
+
+#### flatten5d.assign( x, shape, colexicographic, out, stride, offset )
+
+Flattens a five-dimensional nested array and assigns elements to a provided output array.
+
+```javascript
+var Float64Array = require( '@stdlib/array-float64' );
+
+var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+var out = new Float64Array( 4 );
+
+var y = flatten5d.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 );
+// returns <Float64Array>[ 1, 2, 3, 4 ]
+
+var bool = ( y === out );
+// returns true
+
+y = flatten5d.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0 );
+// returns <Float64Array>[ 1, 3, 2, 4 ]
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   Both functions assume that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var flatten5d = require( '@stdlib/array-base-flatten5d' );
+
+// Define a 2x2x1x2x2 array:
+var x = [
+    [
+        [
+            [
+                [ 1, 2 ], [ 3, 4 ]
+            ]
+        ],
+        [
+            [
+                [ 5, 6 ], [ 7, 8 ]
+            ]
+        ]
+    ],
+    [
+        [
+            [
+                [ 9, 10 ], [ 11, 12 ]
+            ]
+        ],
+        [
+            [
+                [ 13, 14 ], [ 15, 16 ]
+            ]
+        ]
+    ]
+];
+
+var out = flatten5d( x, [ 0, 0, 0, 0, 0 ], false );
+// returns []
+
+out = flatten5d( x, [ 0, 0, 0, 0, 0 ], true );
+// returns []
+
+out = flatten5d( x, [ 1, 1, 1, 1, 1 ], false );
+// returns [ 1 ]
+
+out = flatten5d( x, [ 1, 1, 1, 1, 1 ], true );
+// returns [ 1 ]
+
+out = flatten5d( x, [ 1, 2, 1, 2, 2 ], false );
+// returns [ 1, 2, 3, 4, 5, 6, 7, 8 ]
+
+out = flatten5d( x, [ 1, 2, 1, 2, 2 ], true );
+// returns [ 1, 5, 3, 7, 2, 6, 4, 8 ]
+
+out = flatten5d( x, [ 2, 2, 1, 2, 2 ], false );
+// returns [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]
+
+out = flatten5d( x, [ 2, 2, 1, 2, 2 ], true );
+// returns [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]
+```
+
+</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-2023. 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/array-base-flatten5d.svg
+[npm-url]: https://npmjs.org/package/@stdlib/array-base-flatten5d
+
+[test-image]: https://github.com/stdlib-js/array-base-flatten5d/actions/workflows/test.yml/badge.svg?branch=v0.0.1
+[test-url]: https://github.com/stdlib-js/array-base-flatten5d/actions/workflows/test.yml?query=branch:v0.0.1
+
+[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-flatten5d/main.svg
+[coverage-url]: https://codecov.io/github/stdlib-js/array-base-flatten5d?branch=main
+
+<!--
+
+[dependencies-image]: https://img.shields.io/david/stdlib-js/array-base-flatten5d.svg
+[dependencies-url]: https://david-dm.org/stdlib-js/array-base-flatten5d/main
+
+-->
+
+[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+
+[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/array-base-flatten5d/tree/deno
+[umd-url]: https://github.com/stdlib-js/array-base-flatten5d/tree/umd
+[esm-url]: https://github.com/stdlib-js/array-base-flatten5d/tree/esm
+[branches-url]: https://github.com/stdlib-js/array-base-flatten5d/blob/main/branches.md
+
+[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-flatten5d/main/LICENSE
+
+</section>
+
+<!-- /.links -->

package/docs/types/index.d.ts

@@ -0,0 +1,123 @@
+/*
+* @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 { Collection } from '@stdlib/types/object';
+
+/**
+* Five-dimensional nested array.
+*/
+type Array5D<T> = Array<Array<Array<Array<Collection<T>>>>>;
+
+/**
+* Interface describing `flatten5d`.
+*/
+interface Flatten5d {
+	/**
+	* Flattens a five-dimensional nested array.
+	*
+	* ## Notes
+	*
+	* -   The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+	*
+	* @param x - input array
+	* @param shape - array shape
+	* @param colexicographic - specifies whether to flatten array values in colexicographic order
+	* @returns flattened array
+	*
+	* @example
+	* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+	*
+	* var out = flatten5d( x, [ 2, 1, 1, 1, 2 ], false );
+	* // returns [ 1, 2, 3, 4 ]
+	*
+	* @example
+	* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+	*
+	* var out = flatten5d( x, [ 2, 1, 1, 1, 2 ], true );
+	* // returns [ 1, 3, 2, 4 ]
+	*/
+	<T = unknown>( x: Array5D<T>, shape: Collection<number>, colexicographic: boolean ): Array<T>;
+
+	/**
+	* Flattens a five-dimensional nested array and assigns elements to a provided output array.
+	*
+	* ## Notes
+	*
+	* -   The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+	*
+	* @param x - input array
+	* @param shape - array shape
+	* @param colexicographic - specifies whether to flatten array values in colexicographic order
+	* @param out - output array
+	* @param stride - output array stride
+	* @param offset - output array index offset
+	* @returns output array
+	*
+	* @example
+	* var Float64Array = require( `@stdlib/array/float64` );
+	*
+	* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+	*
+	* var out = flatten5d.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 );
+	* // returns <Float64Array>[ 1, 2, 3, 4 ]
+	*
+	* @example
+	* var Float64Array = require( `@stdlib/array/float64` );
+	*
+	* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+	*
+	* var out = flatten5d.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );
+	* // returns <Float64Array>[ 1, 3, 2, 4 ]
+	*/
+	assign<T = unknown, U = unknown>( x: Array5D<T>, shape: Collection<number>, colexicographic: boolean, out: Collection<U>, stride: number, offset: number ): Collection<T | U>;
+}
+
+/**
+* Flattens a five-dimensional nested array.
+*
+* ## Notes
+*
+* -   The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+*
+* @param x - input array
+* @param shape - array shape
+* @param colexicographic - specifies whether to flatten array values in colexicographic order
+* @returns flattened array
+*
+* @example
+* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+*
+* var out = flatten5d( x, [ 2, 1, 1, 1, 2 ], false );
+* // returns [ 1, 2, 3, 4 ]
+*
+* @example
+* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+*
+* var out = flatten5d( x, [ 2, 1, 1, 1, 2 ], true );
+* // returns [ 1, 3, 2, 4 ]
+*/
+declare var flatten5d: Flatten5d;
+
+
+// EXPORTS //
+
+export = flatten5d;

package/lib/assign.js

@@ -0,0 +1,119 @@
+/**
+* @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.
+*/
+
+/* eslint-disable max-depth */
+
+'use strict';
+
+// MAIN //
+
+/**
+* Flattens a five-dimensional nested array and assigns elements to a provided output array.
+*
+* ## Notes
+*
+* -   The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+*
+* @param {Array<Array<Collection>>} x - input nested array
+* @param {NonNegativeIntegerArray} shape - array shape
+* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order
+* @param {Collection} out - output array
+* @param {integer} stride - output array stride
+* @param {NonNegativeInteger} offset - output array index offset
+* @returns {Collection} output array
+*
+* @example
+* var Float64Array = require( '@stdlib/array-float64' );
+*
+* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+*
+* var out = flatten5d( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0 );
+* // returns <Float64Array>[ 1, 2, 3, 4 ]
+*
+* @example
+* var Float64Array = require( '@stdlib/array-float64' );
+*
+* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+*
+* var out = flatten5d( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0 );
+* // returns <Float64Array>[ 1, 3, 2, 4 ]
+*/
+function flatten5d( x, shape, colexicographic, out, stride, offset ) {
+	var S0;
+	var S1;
+	var S2;
+	var S3;
+	var S4;
+	var i0;
+	var i1;
+	var i2;
+	var i3;
+	var i4;
+	var a0;
+	var a1;
+	var a2;
+	var a3;
+	var io;
+
+	// Extract loop variables:
+	S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices
+	S1 = shape[ 3 ];
+	S2 = shape[ 2 ];
+	S3 = shape[ 1 ];
+	S4 = shape[ 0 ];
+
+	// Iterate over the array dimensions...
+	io = offset;
+	if ( colexicographic ) {
+		for ( i0 = 0; i0 < S0; i0++ ) {
+			for ( i1 = 0; i1 < S1; i1++ ) {
+				for ( i2 = 0; i2 < S2; i2++ ) {
+					for ( i3 = 0; i3 < S3; i3++ ) {
+						for ( i4 = 0; i4 < S4; i4++ ) {
+							out[ io ] = x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ]; // equivalent to storing in column-major (Fortran-style) order
+							io += stride;
+						}
+					}
+				}
+			}
+		}
+		return out;
+	}
+	for ( i4 = 0; i4 < S4; i4++ ) {
+		a3 = x[ i4 ];
+		for ( i3 = 0; i3 < S3; i3++ ) {
+			a2 = a3[ i3 ];
+			for ( i2 = 0; i2 < S2; i2++ ) {
+				a1 = a2[ i2 ];
+				for ( i1 = 0; i1 < S1; i1++ ) {
+					a0 = a1[ i1 ];
+					for ( i0 = 0; i0 < S0; i0++ ) {
+						out[ io ] = a0[ i0 ]; // equivalent to storing in row-major (C-style) order
+						io += stride;
+					}
+				}
+			}
+		}
+	}
+	return out;
+}
+
+
+// EXPORTS //
+
+module.exports = flatten5d;

package/lib/index.js

@@ -0,0 +1,70 @@
+/**
+* @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';
+
+/**
+* Flatten a five-dimensional nested array.
+*
+* @module @stdlib/array-base-flatten5d
+*
+* @example
+* var flatten5d = require( '@stdlib/array-base-flatten5d' );
+*
+* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+*
+* var out = flatten5d( x, [ 2, 1, 1, 1, 2 ], false );
+* // returns [ 1, 2, 3, 4 ]
+*
+* @example
+* var flatten5d = require( '@stdlib/array-base-flatten5d' );
+*
+* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+*
+* var out = flatten5d( x, [ 2, 1, 1, 1, 2 ], true );
+* // returns [ 1, 3, 2, 4 ]
+*
+* @example
+* var Float64Array = require( '@stdlib/array-float64' );
+* var flatten5d = require( '@stdlib/array-base-flatten5d' );
+*
+* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+*
+* var out = new Float64Array( 4 );
+* var y = flatten5d.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0 );
+* // returns <Float64Array>[ 1, 3, 2, 4 ]
+*
+* var bool = ( y === out );
+* // returns true
+*/
+
+// MODULES //
+
+var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
+var main = require( './main.js' );
+var assign = require( './assign.js' );
+
+
+// MAIN //
+
+setReadOnly( main, 'assign', assign );
+
+
+// EXPORTS //
+
+module.exports = main;

package/lib/main.js

@@ -0,0 +1,112 @@
+/**
+* @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.
+*/
+
+/* eslint-disable max-depth */
+
+'use strict';
+
+// MAIN //
+
+/**
+* Flattens a five-dimensional nested array.
+*
+* ## Notes
+*
+* -   The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).
+*
+* @param {Array<Array<Collection>>} x - input nested array
+* @param {NonNegativeIntegerArray} shape - array shape
+* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order
+* @returns {Array} flattened array
+*
+* @example
+* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+*
+* var out = flatten5d( x, [ 2, 1, 1, 1, 2 ], false );
+* // returns [ 1, 2, 3, 4 ]
+*
+* @example
+* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];
+*
+* var out = flatten5d( x, [ 2, 1, 1, 1, 2 ], true );
+* // returns [ 1, 3, 2, 4 ]
+*/
+function flatten5d( x, shape, colexicographic ) {
+	var out;
+	var S0;
+	var S1;
+	var S2;
+	var S3;
+	var S4;
+	var i0;
+	var i1;
+	var i2;
+	var i3;
+	var i4;
+	var a0;
+	var a1;
+	var a2;
+	var a3;
+
+	// Extract loop variables:
+	S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices
+	S1 = shape[ 3 ];
+	S2 = shape[ 2 ];
+	S3 = shape[ 1 ];
+	S4 = shape[ 0 ];
+
+	// Initialize an output array:
+	out = [];
+
+	// Iterate over the array dimensions...
+	if ( colexicographic ) {
+		for ( i0 = 0; i0 < S0; i0++ ) {
+			for ( i1 = 0; i1 < S1; i1++ ) {
+				for ( i2 = 0; i2 < S2; i2++ ) {
+					for ( i3 = 0; i3 < S3; i3++ ) {
+						for ( i4 = 0; i4 < S4; i4++ ) {
+							out.push( x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ] ); // equivalent to storing in column-major (Fortran-style) order
+						}
+					}
+				}
+			}
+		}
+		return out;
+	}
+	for ( i4 = 0; i4 < S4; i4++ ) {
+		a3 = x[ i4 ];
+		for ( i3 = 0; i3 < S3; i3++ ) {
+			a2 = a3[ i3 ];
+			for ( i2 = 0; i2 < S2; i2++ ) {
+				a1 = a2[ i2 ];
+				for ( i1 = 0; i1 < S1; i1++ ) {
+					a0 = a1[ i1 ];
+					for ( i0 = 0; i0 < S0; i0++ ) {
+						out.push( a0[ i0 ] ); // equivalent to storing in row-major (C-style) order
+					}
+				}
+			}
+		}
+	}
+	return out;
+}
+
+
+// EXPORTS //
+
+module.exports = flatten5d;

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@stdlib/array-base-flatten5d",
+  "version": "0.0.1",
+  "description": "Flatten a five-dimensional nested array.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "main": "./lib",
+  "directories": {
+    "benchmark": "./benchmark",
+    "doc": "./docs",
+    "example": "./examples",
+    "lib": "./lib",
+    "test": "./test"
+  },
+  "types": "./docs/types",
+  "scripts": {
+    "test": "make test",
+    "test-cov": "make test-cov",
+    "examples": "make examples",
+    "benchmark": "make benchmark"
+  },
+  "homepage": "https://stdlib.io",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/array-base-flatten5d.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {
+    "@stdlib/types": "^0.0.14",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7"
+  },
+  "devDependencies": {
+    "@stdlib/array-base-filled": "^0.0.2",
+    "@stdlib/array-base-zero-to": "^0.0.6",
+    "@stdlib/array-float64": "^0.0.6",
+    "@stdlib/assert-has-own-property": "^0.0.7",
+    "@stdlib/assert-is-array": "^0.0.7",
+    "@stdlib/assert-is-float64array": "^0.0.8",
+    "@stdlib/bench": "^0.0.12",
+    "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
+    "istanbul": "^0.4.1",
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
+  },
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "utilities",
+    "utils",
+    "generic",
+    "array",
+    "flatten",
+    "flat",
+    "5d",
+    "tensor",
+    "strided",
+    "ndarray",
+    "multidimensional"
+  ],
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
+  }
+}