From 577fb76b77d47d7388bdc3cae97352109317732a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Apr 2022 04:27:36 +0000 Subject: [PATCH 001/127] Auto-generated commit a61c60c925b250852b7b815b303ba348760a8c96 --- CONTRIBUTORS | 28 + LICENSE | 481 +++++++++ NOTICE | 1 + README.md | 289 ++++++ index.d.ts | 180 ++++ index.mjs | 4 + index.mjs.map | 1 + package.json | 40 + stats.html | 2689 +++++++++++++++++++++++++++++++++++++++++++++++++ 9 files changed, 3713 insertions(+) create mode 100644 CONTRIBUTORS create mode 100644 LICENSE create mode 100644 NOTICE create mode 100644 README.md create mode 100644 index.d.ts create mode 100644 index.mjs create mode 100644 index.mjs.map create mode 100644 package.json create mode 100644 stats.html diff --git a/CONTRIBUTORS b/CONTRIBUTORS new file mode 100644 index 0000000..e5c896d --- /dev/null +++ b/CONTRIBUTORS @@ -0,0 +1,28 @@ +# This file is generated by tools/scripts/update_contributors. +# +# Contributors listed in alphabetical order. + +Ali Salesi +Athan Reines +Brendan Graetz +Bruno Fenzl +Christopher Dambamuromo +Dominik Moritz +Frank Kovacs +James +Jithin KS +Joey Reed +Joris Labie +Justin Dennison +Marcus +Matt Cochrane +Milan Raj +Momtchil Momtchev +Ognjen Jevremović +Philipp Burckhardt +Ricky Reusser +Ryan Seal +Seyyed Parsa Neshaei +Shraddheya Shendre +dorrin-sot <59933477+dorrin-sot@users.noreply.github.com> +rei2hu diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..fcc9934 --- /dev/null +++ b/LICENSE @@ -0,0 +1,481 @@ + + 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 + + + +Boost Software License - Version 1.0 - August 17th, 2003 + +Permission is hereby granted, free of charge, to any person or organization +obtaining a copy of the software and accompanying documentation covered by this +license (the "Software") to use, reproduce, display, distribute, execute, and +transmit the Software, and to prepare derivative works of the Software, and to +permit third-parties to whom the Software is furnished to do so, all subject to +the following: + +The copyright notices in the Software and this entire statement, including the +above license grant, this restriction and the following disclaimer, must be +included in all copies of the Software, in whole or in part, and all derivative +works of the Software, unless such copies or derivative works are solely in the +form of machine-executable object code generated by a source language processor. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE +COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES +OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF +OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + + + +DEPENDENCIES + +The library links against the following external libraries, which have their own +licenses: + +* OpenBLAS + +Copyright (c) 2011-2014, The OpenBLAS Project +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + + 3. Neither the name of the OpenBLAS project nor the names of + its contributors may be used to endorse or promote products + derived from this software without specific prior written + permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF +THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + +* Electron + +Copyright (c) 2013-2017 GitHub Inc. + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +* Boost + +Boost Software License - Version 1.0 - August 17th, 2003 + +Permission is hereby granted, free of charge, to any person or organization +obtaining a copy of the software and accompanying documentation covered by +this license (the "Software") to use, reproduce, display, distribute, +execute, and transmit the Software, and to prepare derivative works of the +Software, and to permit third-parties to whom the Software is furnished to +do so, all subject to the following: + +The copyright notices in the Software and this entire statement, including +the above license grant, this restriction and the following disclaimer, +must be included in all copies of the Software, in whole or in part, and +all derivative works of the Software, unless such copies or derivative +works are solely in the form of machine-executable object code generated by +a source language processor. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +* Cephes + +Copyright (c) 1984-2000 Stephen L. Moshier + +Some software in this archive may be from the book _Methods and Programs for +Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989) +or from the Cephes Mathematical Library, a commercial product. In either event, +it is copyrighted by the author. What you see here may be used freely but it +comes with no support or guarantee. + +Stephen L. Moshier +moshier@na-net.ornl.gov + + + +ATTRIBUTION + +The library contains implementations from the following external libraries, +which have their own licenses: + +* FreeBSD + +Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved. + +Developed at SunPro, a Sun Microsystems, Inc. business. +Permission to use, copy, modify, and distribute this +software is freely granted, provided that this notice +is preserved. + + +* FDLIBM + +Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved. + +Developed at SunPro, a Sun Microsystems, Inc. business. +Permission to use, copy, modify, and distribute this +software is freely granted, provided that this notice +is preserved. + + +* Go + +Copyright (c) 2009 The Go Authors. All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above +copyright notice, this list of conditions and the following disclaimer +in the documentation and/or other materials provided with the +distribution. + * Neither the name of Google Inc. nor the names of its +contributors may be used to endorse or promote products derived from +this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + +* SLATEC Common Mathematical Library + +Public domain. + + +* ESLint + +Copyright JS Foundation and other contributors, https://js.foundation + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + +* StatsFuns.jl + +Copyright (c) 2015: Dahua Lin. + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +* SpecialFunctions.jl + +The MIT License (MIT) + +Copyright (c) 2017 Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and others: + +https://github.com/JuliaMath/SpecialFunctions.jl/graphs/contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + + +* MT19937 + +Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura, +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + 3. The names of its contributors may not be used to endorse or promote + products derived from this software without specific prior written + permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..10e6ba1 --- /dev/null +++ b/NOTICE @@ -0,0 +1 @@ +Copyright (c) 2016-2022 The Stdlib Authors. diff --git a/README.md b/README.md new file mode 100644 index 0000000..99ad2b4 --- /dev/null +++ b/README.md @@ -0,0 +1,289 @@ + + +# ind2sub + +[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] + +> Convert a linear index to an array of subscripts. + + + +
+ +
+ + + + + + + +
+ +## Usage + +```javascript +import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; +``` + +#### ind2sub( shape, idx\[, options] ) + +Converts a linear index to an array of subscripts. + +```javascript +var shape = [ 2, 2 ]; + +var s = ind2sub( shape, 2 ); +// returns [ 1, 0 ] +``` + +The function supports the following `options`: + +- `mode`: specifies how to handle a linear index which exceeds array dimensions. The following modes are supported: + + - `throw`: specifies that the function should throw an error when a linear index exceeds array dimensions. + - `wrap`: specifies that the function should wrap around a linear index exceeding array dimensions using modulo arithmetic. + - `clamp`: specifies that the function should set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. + +- `order`: specifies whether an array is `row-major` (C-style) or `column-major` (Fortran-style). Default: `'row-major'`. + +By default, the function assumes a row-major array. To return subscripts for a column-major array, set the `order` option. + +```javascript +var shape = [ 2, 2 ]; +var opts = {}; + +opts.order = 'column-major'; +var s = ind2sub( shape, 1, opts ); +// returns [ 1, 0 ] +``` + +By default, the function throws an `error` if provided a linear index which exceeds array dimensions. To specify alternative behavior, set the `mode` option. + +```javascript +var shape = [ 2, 2 ]; +var opts = {}; + +opts.mode = 'wrap'; +var s = ind2sub( shape, -5, opts ); +// returns [ 1, 1 ] + +opts.mode = 'clamp'; +s = ind2sub( shape, 7, opts ); +// returns [ 1, 1 ] +``` + +#### ind2sub.assign( shape, idx\[, options], out ) + +Converts a linear index to an array of subscripts and assigns results to a provided output array. + +```javascript +var shape = [ 2, 2 ]; +var out = [ 0, 0 ]; + +var subscripts = ind2sub.assign( shape, 1, out ); +// returns [ 0, 1 ] + +var bool = ( subscripts === out ); +// returns true +``` + +The function accepts the same `options` as above. + +
+ + + + + +
+ +
+ + + + + +
+ +## Examples + + + +```html + + + + + + +``` + +
+ + + + + +
+ +
+ + + + + +
+ +* * * + +## See Also + +- [`@stdlib/ndarray/array`][@stdlib/ndarray/array]: multidimensional arrays. +- [`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor. +- [`@stdlib/ndarray/sub2ind`][@stdlib/ndarray/sub2ind]: convert subscripts to a linear index. + +
+ + + + + + +
+ +* * * + +## Notice + +This package is part of [stdlib][stdlib], a standard library 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 © 2016-2022. The Stdlib [Authors][stdlib-authors]. + +
+ + + + + +
+ +[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-ind2sub.svg +[npm-url]: https://npmjs.org/package/@stdlib/ndarray-ind2sub + +[test-image]: https://github.com/stdlib-js/ndarray-ind2sub/actions/workflows/test.yml/badge.svg?branch=main +[test-url]: https://github.com/stdlib-js/ndarray-ind2sub/actions/workflows/test.yml?query=branch:main + +[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-ind2sub/main.svg +[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-ind2sub?branch=main + + + +[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg +[chat-url]: https://gitter.im/stdlib-js/stdlib/ + +[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/ndarray-ind2sub/tree/deno +[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd +[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm + +[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-ind2sub/main/LICENSE + + + +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm + +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm + +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm + + + +
+ + diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 0000000..f06b08d --- /dev/null +++ b/index.d.ts @@ -0,0 +1,180 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2021 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: 2.0 + +/// +/// + +import { ArrayLike } from '@stdlib/types/array'; +import { Mode, Order } from '@stdlib/types/ndarray'; + +/** +* Interface defining function options. +*/ +interface Options { + /** + * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). + */ + mode?: Mode; + + /** + * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). + */ + order?: Order; +} + +interface Ind2Sub { + /** + * Converts a linear index to an array of subscripts. + * + * ## Notes + * + * - The function accepts the following "modes": + * + * - `throw`: throws an error when a linear index exceeds array dimensions. + * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. + * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. + * + * + * @param shape - array shape + * @param idx - linear index + * @param options - function options + * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') + * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') + * @throws shape argument must be an array-like object containing nonnegative integers + * @throws must provide valid options + * @throws must provide a linear index which does not exceed array dimensions + * @returns subscripts + * + * @example + * var s = ind2sub( [ 3, 3, 3 ], 17 ); + * // returns [ 1, 2, 2 ] + */ + ( shape: ArrayLike, idx: number, options?: Options ): Array; + + /** + * Converts a linear index to an array of subscripts and assigns results to a provided output array. + * + * ## Notes + * + * - The function accepts the following "modes": + * + * - `throw`: throws an error when a linear index exceeds array dimensions. + * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. + * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. + * + * + * @param shape - array shape + * @param idx - linear index + * @param options - function options + * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') + * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') + * @param out - output array + * @throws output argument must be either an array, typed array, or an object + * @throws shape argument must be an array-like object containing nonnegative integers + * @throws must provide valid options + * @throws must provide a linear index which does not exceed array dimensions + * @returns subscripts + * + * @example + * var shape = [ 3, 3, 3 ]; + * var out = [ 0, 0, 0 ]; + * + * var s = ind2sub.assign( shape, 17, out ); + * // returns [ 1, 2, 2 ] + * + * var bool = ( s === out ); + * // returns true + */ + assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length + + /** + * Converts a linear index to an array of subscripts and assigns results to a provided output array. + * + * ## Notes + * + * - The function accepts the following "modes": + * + * - `throw`: throws an error when a linear index exceeds array dimensions. + * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. + * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. + * + * + * @param shape - array shape + * @param idx - linear index + * @param out - output array + * @throws output argument must be either an array, typed array, or an object + * @throws shape argument must be an array-like object containing nonnegative integers + * @throws must provide a linear index which does not exceed array dimensions + * @returns subscripts + * + * @example + * var shape = [ 3, 3, 3 ]; + * var out = [ 0, 0, 0 ]; + * + * var s = ind2sub.assign( shape, 17, out ); + * // returns [ 1, 2, 2 ] + * + * var bool = ( s === out ); + * // returns true + */ + assign( shape: ArrayLike, idx: number, out: any ): Array; +} + +/** +* Converts a linear index to an array of subscripts. +* +* ## Notes +* +* - The function accepts the following "modes": +* +* - `throw`: throws an error when a linear index exceeds array dimensions. +* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. +* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. +* +* +* @param shape - array shape +* @param idx - linear index +* @param options - function options +* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') +* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') +* @throws shape argument must be an array-like object containing nonnegative integers +* @throws must provide valid options +* @throws must provide a linear index which does not exceed array dimensions +* @returns subscripts +* +* @example +* var s = ind2sub( [ 3, 3, 3 ], 17 ); +* // returns [ 1, 2, 2 ] +* +* @example +* var shape = [ 3, 3, 3 ]; +* var out = [ 0, 0, 0 ]; +* +* var s = ind2sub.assign( shape, 17, out ); +* // returns [ 1, 2, 2 ] +* +* var bool = ( s === out ); +* // returns true +*/ +declare var ind2sub: Ind2Sub; + +// EXPORTS // + +export = ind2sub; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3209903 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p={mode:"throw",order:"row-major"},l=o,u=d,g=a,j=m,h=s;var v=function(e,r){return l(r)?u(r,"mode")&&(e.mode=r.mode,!j(e.mode))?new TypeError(h("invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.","mode",e.mode)):u(r,"order")&&(e.order=r.order,!g(e.order))?new TypeError(h("invalid option. `%s` option must be a supported/recognized order. Option: `%s`.","order",e.order)):null:new TypeError(h("invalid argument. Options argument must be an object. Value: `%s`.",r))},b=r.primitives,f=t.isPrimitive,y=n,c=i,w=s,x=p,E=v;var T=function(e,r,t){var n,i;if((n={}).mode=x.mode,n.order=x.order,arguments.length>2&&(i=E(n,t)))throw i;if(!b(e))throw new TypeError(w("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!f(r))throw new TypeError(w("invalid argument. Linear index argument must be integer valued. Value: `%s`.",r));return c(e,y(e,n.order),0,n.order,r,n.mode)},V=r.primitives,O=t.isPrimitive,k=n,z=i.assign,L=s,P=p,S=v;var q=T,A=function(e,r,t,n){var i,s,o;if((i={}).mode=P.mode,i.order=P.order,4===arguments.length){if(o=S(i,arguments[2]))throw o;if("object"!=typeof n||null===n)throw new TypeError(L("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",n));s=n}else if("object"!=typeof(s=t)||null===s)throw new TypeError(L("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",s));if(!V(e))throw new TypeError(L("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!O(r))throw new TypeError(L("invalid argument. Linear index argument must be integer valued. Value: `%s`.",r));return z(e,k(e,i.order),0,i.order,r,i.mode,s)};e(q,"assign",A);var B=q;export{A as assign,B as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..e7c279a --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index argument must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index argument must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],"names":["isObject","require$$0","hasOwnProp","require$$1","isOrder","require$$2","isIndexMode","require$$3","format","require$$4","validate_1","opts","options","mode","TypeError","order","isNonNegativeIntegerArray","primitives","isInteger","isPrimitive","shape2strides","getSubscripts","defaults","require$$5","validate","require$$6","main","shape","idx","err","arguments","length","assign","out","dest","lib"],"mappings":";;q9BAsBIA,EAAWC,EACXC,EAAaC,EACbC,EAAUC,EACVC,EAAcC,EACdC,EAASC,EAgDb,IAAAC,EAtBA,SAAmBC,EAAMC,GACxB,OAAMZ,EAAUY,GAGXV,EAAYU,EAAS,UACzBD,EAAKE,KAAOD,EAAQC,MACdP,EAAaK,EAAKE,OAChB,IAAIC,UAAWN,EAAQ,iFAAkF,OAAQG,EAAKE,OAG1HX,EAAYU,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,OACfX,EAASO,EAAKI,QACZ,IAAID,UAAWN,EAAQ,kFAAmF,QAASG,EAAKI,QAG1H,KAdC,IAAID,UAAWN,EAAQ,qEAAsEI,KChClGI,EAA4Bf,EAAyDgB,WACrFC,EAAYf,EAAuCgB,YACnDC,EAAgBf,EAChBgB,EAAgBd,EAChBC,EAASC,EACTa,EAAWC,EACXC,EAAWC,EA2Df,IAAAC,EA1BA,SAAkBC,EAAOC,EAAKhB,GAC7B,IAAID,EACAkB,EAKJ,IAHAlB,EAAO,IACFE,KAAOS,EAAST,KACrBF,EAAKI,MAAQO,EAASP,MACjBe,UAAUC,OAAS,IACvBF,EAAML,EAAUb,EAAMC,IAErB,MAAMiB,EAGR,IAAMb,EAA2BW,GAChC,MAAM,IAAIb,UAAWN,EAAQ,8GAA+GmB,IAE7I,IAAMT,EAAWU,GAChB,MAAM,IAAId,UAAWN,EAAQ,+EAAgFoB,IAG9G,OAAOP,EAAeM,EAAOP,EAAeO,EAAOhB,EAAKI,OAAS,EAAGJ,EAAKI,MAAOa,EAAKjB,EAAKE,OC3DvFG,EAA4Bf,EAAyDgB,WACrFC,EAAYf,EAAuCgB,YACnDC,EAAgBf,EAChBgB,EAAgBd,EAA0CyB,OAC1DxB,EAASC,EACTa,EAAWC,EACXC,EAAWC,EA6Ef,IC1DAC,EAAAvB,EACA6B,EDqBA,SAAkBL,EAAOC,EAAKhB,EAASqB,GACtC,IAAItB,EACAuB,EACAL,EAKJ,IAHAlB,EAAO,IACFE,KAAOS,EAAST,KACrBF,EAAKI,MAAQO,EAASP,MACI,IAArBe,UAAUC,OAAe,CAE7B,GADAF,EAAML,EAAUb,EAAMmB,UAAW,IAEhC,MAAMD,EAEP,GAAoB,iBAARI,GAA4B,OAARA,EAC/B,MAAM,IAAInB,UAAWN,EAAQ,kGAAmGyB,IAEjIC,EAAOD,OAGP,GAAqB,iBADrBC,EAAOtB,IACmC,OAATsB,EAChC,MAAM,IAAIpB,UAAWN,EAAQ,kGAAmG0B,IAGlI,IAAMlB,EAA2BW,GAChC,MAAM,IAAIb,UAAWN,EAAQ,8GAA+GmB,IAE7I,IAAMT,EAAWU,GAChB,MAAM,IAAId,UAAWN,EAAQ,+EAAgFoB,IAG9G,OAAOP,EAAeM,EAAOP,EAAeO,EAAOhB,EAAKI,OAAS,EAAGJ,EAAKI,MAAOa,EAAKjB,EAAKE,KAAMqB,ICrDjGjC,EAOAyB,EAAA,SAAAM,GAKA,IAAAG,EAAAT"} \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..ff1f364 --- /dev/null +++ b/package.json @@ -0,0 +1,40 @@ +{ + "name": "@stdlib/ndarray-ind2sub", + "version": "0.0.0", + "description": "Convert a linear index to an array of subscripts.", + "license": "Apache-2.0", + "type": "module", + "main": "./index.mjs", + "homepage": "https://stdlib.io", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/ndarray-ind2sub.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "keywords": [ + "stdlib", + "stdtypes", + "types", + "ndarray", + "shape", + "multidimensional", + "array", + "utilities", + "utility", + "utils", + "util", + "ind2sub", + "sub2ind", + "subscript", + "linear", + "index", + "idx", + "strided" + ], + "funding": { + "type": "patreon", + "url": "https://www.patreon.com/athan" + } +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1ff9920 --- /dev/null +++ b/stats.html @@ -0,0 +1,2689 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + From fefc085f330209f499d7da097ce98c3863557da7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 30 Jun 2022 22:17:30 +0000 Subject: [PATCH 002/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 92f51f7..5fd7516 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.x", "@stdlib/ndarray-base-ind2sub": "^0.0.x", "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" }, From 0db2581416d93c960b585ccda53fac297a017363 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Jul 2022 06:26:19 +0000 Subject: [PATCH 003/127] Remove files --- index.d.ts | 180 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 2689 ------------------------------------------------- 4 files changed, 2874 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 3209903..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p={mode:"throw",order:"row-major"},l=o,u=d,g=a,j=m,h=s;var v=function(e,r){return l(r)?u(r,"mode")&&(e.mode=r.mode,!j(e.mode))?new TypeError(h("invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.","mode",e.mode)):u(r,"order")&&(e.order=r.order,!g(e.order))?new TypeError(h("invalid option. `%s` option must be a supported/recognized order. Option: `%s`.","order",e.order)):null:new TypeError(h("invalid argument. Options argument must be an object. Value: `%s`.",r))},b=r.primitives,f=t.isPrimitive,y=n,c=i,w=s,x=p,E=v;var T=function(e,r,t){var n,i;if((n={}).mode=x.mode,n.order=x.order,arguments.length>2&&(i=E(n,t)))throw i;if(!b(e))throw new TypeError(w("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!f(r))throw new TypeError(w("invalid argument. Linear index argument must be integer valued. Value: `%s`.",r));return c(e,y(e,n.order),0,n.order,r,n.mode)},V=r.primitives,O=t.isPrimitive,k=n,z=i.assign,L=s,P=p,S=v;var q=T,A=function(e,r,t,n){var i,s,o;if((i={}).mode=P.mode,i.order=P.order,4===arguments.length){if(o=S(i,arguments[2]))throw o;if("object"!=typeof n||null===n)throw new TypeError(L("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",n));s=n}else if("object"!=typeof(s=t)||null===s)throw new TypeError(L("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",s));if(!V(e))throw new TypeError(L("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!O(r))throw new TypeError(L("invalid argument. Linear index argument must be integer valued. Value: `%s`.",r));return z(e,k(e,i.order),0,i.order,r,i.mode,s)};e(q,"assign",A);var B=q;export{A as assign,B as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index e7c279a..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index argument must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index argument must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],"names":["isObject","require$$0","hasOwnProp","require$$1","isOrder","require$$2","isIndexMode","require$$3","format","require$$4","validate_1","opts","options","mode","TypeError","order","isNonNegativeIntegerArray","primitives","isInteger","isPrimitive","shape2strides","getSubscripts","defaults","require$$5","validate","require$$6","main","shape","idx","err","arguments","length","assign","out","dest","lib"],"mappings":";;q9BAsBIA,EAAWC,EACXC,EAAaC,EACbC,EAAUC,EACVC,EAAcC,EACdC,EAASC,EAgDb,IAAAC,EAtBA,SAAmBC,EAAMC,GACxB,OAAMZ,EAAUY,GAGXV,EAAYU,EAAS,UACzBD,EAAKE,KAAOD,EAAQC,MACdP,EAAaK,EAAKE,OAChB,IAAIC,UAAWN,EAAQ,iFAAkF,OAAQG,EAAKE,OAG1HX,EAAYU,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,OACfX,EAASO,EAAKI,QACZ,IAAID,UAAWN,EAAQ,kFAAmF,QAASG,EAAKI,QAG1H,KAdC,IAAID,UAAWN,EAAQ,qEAAsEI,KChClGI,EAA4Bf,EAAyDgB,WACrFC,EAAYf,EAAuCgB,YACnDC,EAAgBf,EAChBgB,EAAgBd,EAChBC,EAASC,EACTa,EAAWC,EACXC,EAAWC,EA2Df,IAAAC,EA1BA,SAAkBC,EAAOC,EAAKhB,GAC7B,IAAID,EACAkB,EAKJ,IAHAlB,EAAO,IACFE,KAAOS,EAAST,KACrBF,EAAKI,MAAQO,EAASP,MACjBe,UAAUC,OAAS,IACvBF,EAAML,EAAUb,EAAMC,IAErB,MAAMiB,EAGR,IAAMb,EAA2BW,GAChC,MAAM,IAAIb,UAAWN,EAAQ,8GAA+GmB,IAE7I,IAAMT,EAAWU,GAChB,MAAM,IAAId,UAAWN,EAAQ,+EAAgFoB,IAG9G,OAAOP,EAAeM,EAAOP,EAAeO,EAAOhB,EAAKI,OAAS,EAAGJ,EAAKI,MAAOa,EAAKjB,EAAKE,OC3DvFG,EAA4Bf,EAAyDgB,WACrFC,EAAYf,EAAuCgB,YACnDC,EAAgBf,EAChBgB,EAAgBd,EAA0CyB,OAC1DxB,EAASC,EACTa,EAAWC,EACXC,EAAWC,EA6Ef,IC1DAC,EAAAvB,EACA6B,EDqBA,SAAkBL,EAAOC,EAAKhB,EAASqB,GACtC,IAAItB,EACAuB,EACAL,EAKJ,IAHAlB,EAAO,IACFE,KAAOS,EAAST,KACrBF,EAAKI,MAAQO,EAASP,MACI,IAArBe,UAAUC,OAAe,CAE7B,GADAF,EAAML,EAAUb,EAAMmB,UAAW,IAEhC,MAAMD,EAEP,GAAoB,iBAARI,GAA4B,OAARA,EAC/B,MAAM,IAAInB,UAAWN,EAAQ,kGAAmGyB,IAEjIC,EAAOD,OAGP,GAAqB,iBADrBC,EAAOtB,IACmC,OAATsB,EAChC,MAAM,IAAIpB,UAAWN,EAAQ,kGAAmG0B,IAGlI,IAAMlB,EAA2BW,GAChC,MAAM,IAAIb,UAAWN,EAAQ,8GAA+GmB,IAE7I,IAAMT,EAAWU,GAChB,MAAM,IAAId,UAAWN,EAAQ,+EAAgFoB,IAG9G,OAAOP,EAAeM,EAAOP,EAAeO,EAAOhB,EAAKI,OAAS,EAAGJ,EAAKI,MAAOa,EAAKjB,EAAKE,KAAMqB,ICrDjGjC,EAOAyB,EAAA,SAAAM,GAKA,IAAAG,EAAAT"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1ff9920..0000000 --- a/stats.html +++ /dev/null @@ -1,2689 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 161a55becdb2994a6e262e26faaaf868df05e6a9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Jul 2022 06:27:12 +0000 Subject: [PATCH 004/127] Auto-generated commit --- .editorconfig | 181 -- .eslintrc.js | 1 - .gitattributes | 33 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 681 ------ .github/workflows/publish.yml | 157 -- .github/workflows/test.yml | 92 - .github/workflows/test_bundles.yml | 180 -- .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 178 -- .npmignore | 227 -- .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 ---- README.md | 47 +- benchmark/benchmark.js | 236 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 -- benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 -- examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 2689 +++++++++++++++++++++ test/test.assign.js | 778 ------ test/test.js | 40 - test/test.main.js | 657 ----- test/test.validate.js | 160 -- 46 files changed, 2720 insertions(+), 5797 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 7212d81..0000000 --- a/.gitattributes +++ /dev/null @@ -1,33 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 53fb341..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-06-30T22:16:37.872Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 29bf533..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a7a7f51..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.9.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 39b1613..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 7ca169c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '0 8 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "::set-output name=package_name::$name" - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "::set-output name=data::$data" - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v2 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v2 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 128c22e..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,681 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the repository: - push: - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "::set-output name=remote-exists::true" - else - echo "::set-output name=remote-exists::false" - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs rm -rf - - git add -A - git commit -m "Remove files" - - git merge -s recursive -X theirs origin/production --allow-unrelated-histories - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch or create new branch tag: - - name: 'Push changes to `deno` branch or create new branch tag' - run: | - SLUG=${{ github.repository }} - VERSION=$(echo ${{ github.ref }} | sed -E -n 's/refs\/tags\/?(v[0-9]+.[0-9]+.[0-9]+).*/\1/p') - if [ -z "$VERSION" ]; then - echo "Workflow job was not triggered by a new tag...." - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - else - echo "Workflow job was triggered by a new tag: $VERSION" - echo "Creating new bundle branch tag of the form $VERSION-deno" - git tag -a $VERSION-deno -m "$VERSION-deno" - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" $VERSION-deno - fi - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "::set-output name=remote-exists::true" - else - echo "::set-output name=remote-exists::false" - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs rm -rf - - git add -A - git commit -m "Remove files" - - git merge -s recursive -X theirs origin/production --allow-unrelated-histories - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "::set-output name=alias::${alias}" - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cc8d287..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index b4629ef..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The function does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The function does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The function does not compile if provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The function does not compile if provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..f68570d --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..770c8f3 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;6/BAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,ICOzC,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,MCZ3F,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,OAGP,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,GC9CjGC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 5fd7516..54faaf7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.x", - "@stdlib/assert-is-integer": "^0.0.x", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.x", - "@stdlib/assert-is-plain-object": "^0.0.x", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.x", - "@stdlib/ndarray-base-assert-is-order": "^0.0.x", - "@stdlib/ndarray-base-ind2sub": "^0.0.x", - "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/math-base-special-floor": "^0.0.x", - "@stdlib/ndarray-base-numel": "^0.0.x", - "@stdlib/random-base-randu": "^0.0.x", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-spec": "5.x.x" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "patreon", "url": "https://www.patreon.com/athan" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..2bcefaa --- /dev/null +++ b/stats.html @@ -0,0 +1,2689 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 013acaab4d15484f3b5b17d61a1b44716c8ba169 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Jul 2022 20:13:56 +0000 Subject: [PATCH 005/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 92f51f7..5fd7516 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.x", "@stdlib/ndarray-base-ind2sub": "^0.0.x", "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" }, From fca36f6521fa45635daef5ba2e5d4f808607c65c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Jul 2022 13:28:58 +0000 Subject: [PATCH 006/127] Remove files --- index.d.ts | 180 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 2689 ------------------------------------------------- 4 files changed, 2874 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index f68570d..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 770c8f3..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;6/BAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,ICOzC,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,MCZ3F,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,OAGP,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,GC9CjGC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2bcefaa..0000000 --- a/stats.html +++ /dev/null @@ -1,2689 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From b7153113c4c864427a59373a187009f739bf5be5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Jul 2022 13:29:50 +0000 Subject: [PATCH 007/127] Auto-generated commit --- .editorconfig | 181 -- .eslintrc.js | 1 - .gitattributes | 33 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 681 ------ .github/workflows/publish.yml | 157 -- .github/workflows/test.yml | 92 - .github/workflows/test_bundles.yml | 180 -- .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 178 -- .npmignore | 227 -- .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 ---- README.md | 47 +- benchmark/benchmark.js | 236 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 -- benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 -- examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 2689 +++++++++++++++++++++ test/test.assign.js | 778 ------ test/test.js | 40 - test/test.main.js | 657 ----- test/test.validate.js | 160 -- 46 files changed, 2720 insertions(+), 5797 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 7212d81..0000000 --- a/.gitattributes +++ /dev/null @@ -1,33 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index a152ccf..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-07-01T01:17:35.862Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 29bf533..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a7a7f51..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.9.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 39b1613..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 7ca169c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '0 8 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "::set-output name=package_name::$name" - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "::set-output name=data::$data" - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v2 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v2 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 128c22e..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,681 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the repository: - push: - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "::set-output name=remote-exists::true" - else - echo "::set-output name=remote-exists::false" - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs rm -rf - - git add -A - git commit -m "Remove files" - - git merge -s recursive -X theirs origin/production --allow-unrelated-histories - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch or create new branch tag: - - name: 'Push changes to `deno` branch or create new branch tag' - run: | - SLUG=${{ github.repository }} - VERSION=$(echo ${{ github.ref }} | sed -E -n 's/refs\/tags\/?(v[0-9]+.[0-9]+.[0-9]+).*/\1/p') - if [ -z "$VERSION" ]; then - echo "Workflow job was not triggered by a new tag...." - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - else - echo "Workflow job was triggered by a new tag: $VERSION" - echo "Creating new bundle branch tag of the form $VERSION-deno" - git tag -a $VERSION-deno -m "$VERSION-deno" - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" $VERSION-deno - fi - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "::set-output name=remote-exists::true" - else - echo "::set-output name=remote-exists::false" - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs rm -rf - - git add -A - git commit -m "Remove files" - - git merge -s recursive -X theirs origin/production --allow-unrelated-histories - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "::set-output name=alias::${alias}" - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cc8d287..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index b4629ef..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The function does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The function does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The function does not compile if provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The function does not compile if provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..f68570d --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..770c8f3 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;6/BAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,ICOzC,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,MCZ3F,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,OAGP,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,GC9CjGC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 5fd7516..54faaf7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.x", - "@stdlib/assert-is-integer": "^0.0.x", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.x", - "@stdlib/assert-is-plain-object": "^0.0.x", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.x", - "@stdlib/ndarray-base-assert-is-order": "^0.0.x", - "@stdlib/ndarray-base-ind2sub": "^0.0.x", - "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/math-base-special-floor": "^0.0.x", - "@stdlib/ndarray-base-numel": "^0.0.x", - "@stdlib/random-base-randu": "^0.0.x", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-spec": "5.x.x" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "patreon", "url": "https://www.patreon.com/athan" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..ce6626a --- /dev/null +++ b/stats.html @@ -0,0 +1,2689 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From aa2bfcdb2e2ebcd3aca6fbd7a37de3f44926f7bd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 6 Jul 2022 18:47:15 +0000 Subject: [PATCH 008/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 92f51f7..5fd7516 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.x", "@stdlib/ndarray-base-ind2sub": "^0.0.x", "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" }, From b91ac83716b82ebec681c5eae38f544c8a858ab5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 6 Jul 2022 19:11:28 +0000 Subject: [PATCH 009/127] Remove files --- index.d.ts | 180 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 2689 ------------------------------------------------- 4 files changed, 2874 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index f68570d..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 770c8f3..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;6/BAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,ICOzC,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,MCZ3F,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,OAGP,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,GC9CjGC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index ce6626a..0000000 --- a/stats.html +++ /dev/null @@ -1,2689 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 09d1cc8d6187bffcba059232fcdc1ffe105433e9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 6 Jul 2022 19:12:20 +0000 Subject: [PATCH 010/127] Auto-generated commit --- .editorconfig | 181 -- .eslintrc.js | 1 - .gitattributes | 33 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 687 ------ .github/workflows/publish.yml | 117 - .github/workflows/test.yml | 92 - .github/workflows/test_bundles.yml | 180 -- .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 178 -- .npmignore | 227 -- .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 ---- README.md | 47 +- benchmark/benchmark.js | 236 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 -- benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 -- examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 2689 +++++++++++++++++++++ test/test.assign.js | 778 ------ test/test.js | 40 - test/test.main.js | 657 ----- test/test.validate.js | 160 -- 45 files changed, 2720 insertions(+), 5762 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 7212d81..0000000 --- a/.gitattributes +++ /dev/null @@ -1,33 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 29bf533..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a7a7f51..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.9.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 39b1613..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 7ca169c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '0 8 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "::set-output name=package_name::$name" - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "::set-output name=data::$data" - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v2 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v2 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 6726965..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,687 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the repository: - push: - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "::set-output name=remote-exists::true" - else - echo "::set-output name=remote-exists::false" - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch or create new branch tag: - - name: 'Push changes to `deno` branch or create new branch tag' - run: | - SLUG=${{ github.repository }} - VERSION=$(echo ${{ github.ref }} | sed -E -n 's/refs\/tags\/?(v[0-9]+.[0-9]+.[0-9]+).*/\1/p') - if [ -z "$VERSION" ]; then - echo "Workflow job was not triggered by a new tag...." - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - else - echo "Workflow job was triggered by a new tag: $VERSION" - echo "Creating new bundle branch tag of the form $VERSION-deno" - git tag -a $VERSION-deno -m "$VERSION-deno" - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" $VERSION-deno - fi - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "::set-output name=remote-exists::true" - else - echo "::set-output name=remote-exists::false" - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "::set-output name=alias::${alias}" - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cc8d287..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index b4629ef..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The function does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The function does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The function does not compile if provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The function does not compile if provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..f68570d --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..770c8f3 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;6/BAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,ICOzC,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,MCZ3F,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,OAGP,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,GC9CjGC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 5fd7516..54faaf7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.x", - "@stdlib/assert-is-integer": "^0.0.x", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.x", - "@stdlib/assert-is-plain-object": "^0.0.x", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.x", - "@stdlib/ndarray-base-assert-is-order": "^0.0.x", - "@stdlib/ndarray-base-ind2sub": "^0.0.x", - "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/math-base-special-floor": "^0.0.x", - "@stdlib/ndarray-base-numel": "^0.0.x", - "@stdlib/random-base-randu": "^0.0.x", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-spec": "5.x.x" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "patreon", "url": "https://www.patreon.com/athan" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1309c5e --- /dev/null +++ b/stats.html @@ -0,0 +1,2689 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 59eb22c94f7ea97e87a064318421bb3a11cce763 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Aug 2022 03:53:35 +0000 Subject: [PATCH 011/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 92f51f7..5fd7516 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.x", "@stdlib/ndarray-base-ind2sub": "^0.0.x", "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" }, From add300351d0bd8f9578931c48c0b64eb29358227 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Aug 2022 11:18:21 +0000 Subject: [PATCH 012/127] Remove files --- index.d.ts | 180 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 2689 ------------------------------------------------- 4 files changed, 2874 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index f68570d..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 770c8f3..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;6/BAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,ICOzC,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,MCZ3F,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,OAGP,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,GC9CjGC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1309c5e..0000000 --- a/stats.html +++ /dev/null @@ -1,2689 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 55eac160a371639cb1b381570f422264b634e128 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Aug 2022 11:19:18 +0000 Subject: [PATCH 013/127] Auto-generated commit --- .editorconfig | 181 -- .eslintrc.js | 1 - .gitattributes | 33 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 760 ------ .github/workflows/publish.yml | 117 - .github/workflows/test.yml | 92 - .github/workflows/test_bundles.yml | 180 -- .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 178 -- .npmignore | 227 -- .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 ---- README.md | 47 +- benchmark/benchmark.js | 236 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 -- benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 -- examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 2689 +++++++++++++++++++++ test/test.assign.js | 778 ------ test/test.js | 40 - test/test.main.js | 657 ----- test/test.validate.js | 160 -- 46 files changed, 2720 insertions(+), 5836 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 7212d81..0000000 --- a/.gitattributes +++ /dev/null @@ -1,33 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 0145604..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-08-01T01:20:53.312Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 29bf533..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a7a7f51..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.9.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 39b1613..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 7ca169c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '0 8 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "::set-output name=package_name::$name" - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "::set-output name=data::$data" - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v2 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v2 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 5094681..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,760 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "::set-output name=remote-exists::true" - else - echo "::set-output name=remote-exists::false" - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "::set-output name=remote-exists::true" - else - echo "::set-output name=remote-exists::false" - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "::set-output name=alias::${alias}" - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cc8d287..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index b4629ef..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The function does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The function does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The function does not compile if provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The function does not compile if provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..9b0b3a3 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..ffe731f --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,ICOzC,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,MCZ3F,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,OAGP,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,GC9CjGC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 5fd7516..54faaf7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.x", - "@stdlib/assert-is-integer": "^0.0.x", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.x", - "@stdlib/assert-is-plain-object": "^0.0.x", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.x", - "@stdlib/ndarray-base-assert-is-order": "^0.0.x", - "@stdlib/ndarray-base-ind2sub": "^0.0.x", - "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/math-base-special-floor": "^0.0.x", - "@stdlib/ndarray-base-numel": "^0.0.x", - "@stdlib/random-base-randu": "^0.0.x", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-spec": "5.x.x" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "patreon", "url": "https://www.patreon.com/athan" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..06b5a3c --- /dev/null +++ b/stats.html @@ -0,0 +1,2689 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 357bbf9a5e8a6b119bdb411a81ca957332791d84 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Sep 2022 03:41:09 +0000 Subject: [PATCH 014/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 92f51f7..5fd7516 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.x", "@stdlib/ndarray-base-ind2sub": "^0.0.x", "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" }, From d61b7b22733986f2b4dd100f5c1b26b8d3c87c15 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Sep 2022 13:54:45 +0000 Subject: [PATCH 015/127] Remove files --- index.d.ts | 180 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 2689 ------------------------------------------------- 4 files changed, 2874 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 9b0b3a3..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index ffe731f..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,ICOzC,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,MCZ3F,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,OAGP,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,GC9CjGC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 06b5a3c..0000000 --- a/stats.html +++ /dev/null @@ -1,2689 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 24b54e13fac10ff01e361d707c48888ba8cf887c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Sep 2022 13:55:39 +0000 Subject: [PATCH 016/127] Auto-generated commit --- .editorconfig | 181 -- .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 760 ------ .github/workflows/publish.yml | 117 - .github/workflows/test.yml | 92 - .github/workflows/test_bundles.yml | 180 -- .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 178 -- .npmignore | 227 -- .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 ---- README.md | 47 +- benchmark/benchmark.js | 236 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 -- benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 -- examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 2689 +++++++++++++++++++++ test/test.assign.js | 778 ------ test/test.js | 40 - test/test.main.js | 657 ----- test/test.validate.js | 160 -- 46 files changed, 2720 insertions(+), 5852 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index e4c2304..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-09-01T01:18:58.896Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 29bf533..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a7a7f51..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.9.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 39b1613..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 7ca169c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '0 8 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "::set-output name=package_name::$name" - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "::set-output name=data::$data" - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v2 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v2 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 5094681..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,760 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "::set-output name=remote-exists::true" - else - echo "::set-output name=remote-exists::false" - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "::set-output name=remote-exists::true" - else - echo "::set-output name=remote-exists::false" - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "::set-output name=alias::${alias}" - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cc8d287..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index b4629ef..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The function does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The function does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The function does not compile if provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The function does not compile if provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..9b0b3a3 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..ffe731f --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,ICOzC,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,MCZ3F,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,OAGP,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,GC9CjGC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 5fd7516..54faaf7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.x", - "@stdlib/assert-is-integer": "^0.0.x", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.x", - "@stdlib/assert-is-plain-object": "^0.0.x", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.x", - "@stdlib/ndarray-base-assert-is-order": "^0.0.x", - "@stdlib/ndarray-base-ind2sub": "^0.0.x", - "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/math-base-special-floor": "^0.0.x", - "@stdlib/ndarray-base-numel": "^0.0.x", - "@stdlib/random-base-randu": "^0.0.x", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-spec": "5.x.x" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "patreon", "url": "https://www.patreon.com/athan" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..124b91f --- /dev/null +++ b/stats.html @@ -0,0 +1,2689 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 8c19ebb811a67aaa95d38367c4c95e285d9beed2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Oct 2022 04:01:12 +0000 Subject: [PATCH 017/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 92f51f7..5fd7516 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.x", "@stdlib/ndarray-base-ind2sub": "^0.0.x", "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" }, From 0e619f482b94e6a430e7bb405a6bc5353bf42dc5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Oct 2022 15:23:49 +0000 Subject: [PATCH 018/127] Remove files --- index.d.ts | 180 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 2689 ------------------------------------------------- 4 files changed, 2874 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 9b0b3a3..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index ffe731f..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,ICOzC,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,MCZ3F,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,OAGP,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,GC9CjGC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 124b91f..0000000 --- a/stats.html +++ /dev/null @@ -1,2689 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 3eb5de9a60478db77b8dbb9a0dcb510f1c05b641 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Oct 2022 15:24:40 +0000 Subject: [PATCH 019/127] Auto-generated commit --- .editorconfig | 181 -- .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 760 ------ .github/workflows/publish.yml | 117 - .github/workflows/test.yml | 92 - .github/workflows/test_bundles.yml | 180 -- .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 178 -- .npmignore | 227 -- .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 ---- README.md | 47 +- benchmark/benchmark.js | 236 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 -- benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 -- examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 2689 +++++++++++++++++++++ test/test.assign.js | 778 ------ test/test.js | 40 - test/test.main.js | 657 ----- test/test.validate.js | 160 -- 46 files changed, 2720 insertions(+), 5852 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index e085243..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-10-01T01:45:25.674Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 29bf533..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a7a7f51..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.9.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 39b1613..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 7ca169c..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '0 8 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "::set-output name=package_name::$name" - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "::set-output name=data::$data" - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v2 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v2 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 5094681..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,760 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "::set-output name=remote-exists::true" - else - echo "::set-output name=remote-exists::false" - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "::set-output name=remote-exists::true" - else - echo "::set-output name=remote-exists::false" - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v2 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "::set-output name=alias::${alias}" - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cc8d287..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..9b0b3a3 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..ffe731f --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,ICOzC,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,MCZ3F,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,OAGP,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,GC9CjGC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 5fd7516..54faaf7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.x", - "@stdlib/assert-is-integer": "^0.0.x", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.x", - "@stdlib/assert-is-plain-object": "^0.0.x", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.x", - "@stdlib/ndarray-base-assert-is-order": "^0.0.x", - "@stdlib/ndarray-base-ind2sub": "^0.0.x", - "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/math-base-special-floor": "^0.0.x", - "@stdlib/ndarray-base-numel": "^0.0.x", - "@stdlib/random-base-randu": "^0.0.x", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-spec": "5.x.x" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "patreon", "url": "https://www.patreon.com/athan" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0c15f1f --- /dev/null +++ b/stats.html @@ -0,0 +1,2689 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 12f8e83b74cbdbab52b6d62f6b77b55ba17ee85d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Nov 2022 03:48:12 +0000 Subject: [PATCH 020/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 92f51f7..5fd7516 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.x", "@stdlib/ndarray-base-ind2sub": "^0.0.x", "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" }, From da0c245b7f0279c26603d826aa0707e0757ea57f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Nov 2022 11:37:34 +0000 Subject: [PATCH 021/127] Remove files --- index.d.ts | 180 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 2689 ------------------------------------------------- 4 files changed, 2874 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 9b0b3a3..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index ffe731f..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,ICOzC,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,MCZ3F,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,IACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,OAGP,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,GC9CjGC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 0c15f1f..0000000 --- a/stats.html +++ /dev/null @@ -1,2689 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 8951b01a8d71c830bd11a68117e2d0b7162cdfc9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Nov 2022 11:38:22 +0000 Subject: [PATCH 022/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 760 ---- .github/workflows/publish.yml | 117 - .github/workflows/test.yml | 92 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 178 - .npmignore | 227 -- .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- benchmark/benchmark.js | 236 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 -- examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 4044 +++++++++++++++++++++ test/test.assign.js | 778 ---- test/test.js | 40 - test/test.main.js | 657 ---- test/test.validate.js | 160 - 46 files changed, 4075 insertions(+), 5852 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index d5d094e..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-11-01T01:32:15.070Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 6b6dd87..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9113bfe..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,760 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cc8d287..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..9b0b3a3 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..5729442 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 5fd7516..54faaf7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.x", - "@stdlib/assert-is-integer": "^0.0.x", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.x", - "@stdlib/assert-is-plain-object": "^0.0.x", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.x", - "@stdlib/ndarray-base-assert-is-order": "^0.0.x", - "@stdlib/ndarray-base-ind2sub": "^0.0.x", - "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/math-base-special-floor": "^0.0.x", - "@stdlib/ndarray-base-numel": "^0.0.x", - "@stdlib/random-base-randu": "^0.0.x", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-spec": "5.x.x" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "patreon", "url": "https://www.patreon.com/athan" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..a6420b9 --- /dev/null +++ b/stats.html @@ -0,0 +1,4044 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 5d016f03c51bf0064b77a6801c3a48f6be7e97fc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 4 Nov 2022 00:18:12 +0000 Subject: [PATCH 023/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 92f51f7..5fd7516 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.x", "@stdlib/ndarray-base-ind2sub": "^0.0.x", "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" }, From 296d50109bfd3049964d25fd35b879d82247d4f8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 4 Nov 2022 08:02:13 +0000 Subject: [PATCH 024/127] Remove files --- index.d.ts | 180 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4044 ------------------------------------------------- 4 files changed, 4229 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 9b0b3a3..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 5729442..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a6420b9..0000000 --- a/stats.html +++ /dev/null @@ -1,4044 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 3d79f79e69a5219297267a030bcdd0b769400908 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 4 Nov 2022 08:03:05 +0000 Subject: [PATCH 025/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 781 ---- .github/workflows/publish.yml | 117 - .github/workflows/test.yml | 92 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 178 - .npmignore | 227 -- .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- benchmark/benchmark.js | 236 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 -- examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 4044 +++++++++++++++++++++ test/test.assign.js | 778 ---- test/test.js | 40 - test/test.main.js | 657 ---- test/test.validate.js | 160 - 46 files changed, 4075 insertions(+), 5873 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 234aa6d..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-11-03T22:14:28.154Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 6b6dd87..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 37ddb4f..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,781 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cc8d287..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..9b0b3a3 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..5729442 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 5fd7516..54faaf7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.x", - "@stdlib/assert-is-integer": "^0.0.x", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.x", - "@stdlib/assert-is-plain-object": "^0.0.x", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.x", - "@stdlib/ndarray-base-assert-is-order": "^0.0.x", - "@stdlib/ndarray-base-ind2sub": "^0.0.x", - "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/math-base-special-floor": "^0.0.x", - "@stdlib/ndarray-base-numel": "^0.0.x", - "@stdlib/random-base-randu": "^0.0.x", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-spec": "5.x.x" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "patreon", "url": "https://www.patreon.com/athan" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..745667d --- /dev/null +++ b/stats.html @@ -0,0 +1,4044 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From b4c1e1ef6ac28053c27ad72b2982ca64334e927b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Dec 2022 02:04:52 +0000 Subject: [PATCH 026/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 41fb2a3..8570397 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.x", "@stdlib/ndarray-base-ind2sub": "^0.0.x", "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" }, From 02a56272ca0d26841dd4da07d7f8d63ecf66307b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Dec 2022 17:51:38 +0000 Subject: [PATCH 027/127] Remove files --- index.d.ts | 180 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4044 ------------------------------------------------- 4 files changed, 4229 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 9b0b3a3..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 5729442..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object' ;\nimport hasOwnProp from '@stdlib/assert-has-own-property' ;\nimport isOrder from '@stdlib/ndarray-base-assert-is-order' ;\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array' ;\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer' ;\nimport shape2strides from '@stdlib/ndarray-base-shape2strides' ;\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub' ;\nimport format from '@stdlib/error-tools-fmtprodmsg' ;\nimport defaults from './defaults.json' ;\nimport validate from './validate.js' ;\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub' ;\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property' ;\nimport main from './main.js' ;\nimport assign from './assign.js' ;\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 745667d..0000000 --- a/stats.html +++ /dev/null @@ -1,4044 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 1d0c70c56740545acf25fb49e63a653961beab91 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Dec 2022 17:52:41 +0000 Subject: [PATCH 028/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 781 ---- .github/workflows/publish.yml | 117 - .github/workflows/test.yml | 92 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 183 - .npmignore | 227 -- .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- benchmark/benchmark.js | 236 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 -- examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 4044 +++++++++++++++++++++ test/test.assign.js | 778 ---- test/test.js | 40 - test/test.main.js | 657 ---- test/test.validate.js | 160 - 46 files changed, 4075 insertions(+), 5878 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index f0d496d..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2022-12-01T02:04:11.806Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 6b6dd87..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 37ddb4f..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,781 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cc8d287..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..9b0b3a3 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..a66d01e --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 8570397..54faaf7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.x", - "@stdlib/assert-is-integer": "^0.0.x", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.x", - "@stdlib/assert-is-plain-object": "^0.0.x", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.x", - "@stdlib/ndarray-base-assert-is-order": "^0.0.x", - "@stdlib/ndarray-base-ind2sub": "^0.0.x", - "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/math-base-special-floor": "^0.0.x", - "@stdlib/ndarray-base-numel": "^0.0.x", - "@stdlib/random-base-randu": "^0.0.x", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "2.x.x" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "patreon", "url": "https://www.patreon.com/athan" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c8bac99 --- /dev/null +++ b/stats.html @@ -0,0 +1,4044 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From e89fcd2ea5f0a634318560f4ae6744af49d5457d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Jan 2023 03:39:34 +0000 Subject: [PATCH 029/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 1493a6e..14435ff 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.x", "@stdlib/ndarray-base-ind2sub": "^0.0.x", "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" }, From 67dcbd9e699d3a18eb5923f7f4aa4f3cb75ababa Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Jan 2023 08:54:40 +0000 Subject: [PATCH 030/127] Remove files --- index.d.ts | 180 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4044 ------------------------------------------------- 4 files changed, 4229 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 9b0b3a3..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2022 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index a66d01e..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c8bac99..0000000 --- a/stats.html +++ /dev/null @@ -1,4044 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 1369e52d6da0b6dd52ba33e2a7e31db69e3de4dd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Jan 2023 08:55:32 +0000 Subject: [PATCH 031/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 791 ---- .github/workflows/publish.yml | 117 - .github/workflows/test.yml | 92 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 184 - .npmignore | 227 -- .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- benchmark/benchmark.js | 236 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 -- examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 4044 +++++++++++++++++++++ test/test.assign.js | 778 ---- test/test.js | 40 - test/test.main.js | 657 ---- test/test.validate.js | 160 - 46 files changed, 4075 insertions(+), 5889 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 13942fd..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-01-01T01:23:07.846Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 6b6dd87..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4eea88..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,791 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cc8d287..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4061660 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..a66d01e --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 14435ff..54faaf7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.x", - "@stdlib/assert-is-integer": "^0.0.x", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.x", - "@stdlib/assert-is-plain-object": "^0.0.x", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.x", - "@stdlib/ndarray-base-assert-is-order": "^0.0.x", - "@stdlib/ndarray-base-ind2sub": "^0.0.x", - "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/math-base-special-floor": "^0.0.x", - "@stdlib/ndarray-base-numel": "^0.0.x", - "@stdlib/random-base-randu": "^0.0.x", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "patreon", "url": "https://www.patreon.com/athan" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d616111 --- /dev/null +++ b/stats.html @@ -0,0 +1,4044 @@ + + + + + + + + RollUp Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 94feb057d410a72e932e435634706bc12493fa03 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Feb 2023 01:51:28 +0000 Subject: [PATCH 032/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 1493a6e..14435ff 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.x", "@stdlib/ndarray-base-ind2sub": "^0.0.x", "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/string-format": "^0.0.x", + "@stdlib/error-tools-fmtprodmsg": "^0.0.x", "@stdlib/types": "^0.0.x", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" }, From 937b48cbb2cbbca03603bffa8d38561109e354b5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Feb 2023 12:22:43 +0000 Subject: [PATCH 033/127] Remove files --- index.d.ts | 180 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4044 ------------------------------------------------- 4 files changed, 4229 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4061660..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index a66d01e..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d616111..0000000 --- a/stats.html +++ /dev/null @@ -1,4044 +0,0 @@ - - - - - - - - RollUp Visualizer - - - -
- - - - - From 1f9ad76aacd2017019f687ba63449958762b03c2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Feb 2023 12:23:39 +0000 Subject: [PATCH 034/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 791 --- .github/workflows/publish.yml | 117 - .github/workflows/test.yml | 92 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 184 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 236 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 778 --- test/test.js | 40 - test/test.main.js | 657 --- test/test.validate.js | 160 - 46 files changed, 6208 insertions(+), 5889 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 5db2ff6..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-02-01T01:50:40.757Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 6b6dd87..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4eea88..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,791 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\"/\"@stdlib\/error-tools-fmtprodmsg\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^0.0.x'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index cc8d287..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4061660 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..a66d01e --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 14435ff..54faaf7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.x", - "@stdlib/assert-is-integer": "^0.0.x", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.x", - "@stdlib/assert-is-plain-object": "^0.0.x", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.x", - "@stdlib/ndarray-base-assert-is-order": "^0.0.x", - "@stdlib/ndarray-base-ind2sub": "^0.0.x", - "@stdlib/ndarray-base-shape2strides": "^0.0.x", - "@stdlib/error-tools-fmtprodmsg": "^0.0.x", - "@stdlib/types": "^0.0.x", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.x", - "@stdlib/assert-is-array": "^0.0.x", - "@stdlib/bench": "^0.0.x", - "@stdlib/math-base-special-floor": "^0.0.x", - "@stdlib/ndarray-base-numel": "^0.0.x", - "@stdlib/random-base-randu": "^0.0.x", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "patreon", "url": "https://www.patreon.com/athan" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..fcac7b5 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From b3d0f84114c6fb26f3a780b07d6c61e2623e945e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Mar 2023 07:28:19 +0000 Subject: [PATCH 035/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 4095af0..760c843 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.7", "@stdlib/ndarray-base-ind2sub": "^0.0.8", "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" }, From 6dd8b34f335f66e15072ff3041d2b115d1830edf Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Mar 2023 16:46:10 +0000 Subject: [PATCH 036/127] Remove files --- index.d.ts | 180 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6362 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4061660..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index a66d01e..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index fcac7b5..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 8204fddd4dfac182ffd6cf8baad73fc9e439c517 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Mar 2023 16:47:11 +0000 Subject: [PATCH 037/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 236 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 236 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 778 --- test/test.js | 40 - test/test.main.js | 657 --- test/test.validate.js | 160 - 46 files changed, 6208 insertions(+), 6024 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 4644859..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-03-01T04:48:57.072Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 6b6dd87..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..e182d3f --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..99373fd --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;6/BAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 760c843..66081b7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-integer": "^0.0.8", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.8", - "@stdlib/assert-is-plain-object": "^0.0.7", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.7", - "@stdlib/ndarray-base-assert-is-order": "^0.0.7", - "@stdlib/ndarray-base-ind2sub": "^0.0.8", - "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.7", - "@stdlib/assert-is-array": "^0.0.7", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-special-floor": "^0.0.8", - "@stdlib/ndarray-base-numel": "^0.0.8", - "@stdlib/random-base-randu": "^0.0.8", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..06ba572 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From c43f73e0eeea080dc3d41f52ebcd8e072751088c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Apr 2023 07:58:06 +0000 Subject: [PATCH 038/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 4095af0..760c843 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.7", "@stdlib/ndarray-base-ind2sub": "^0.0.8", "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" }, From 4d92861fc50054ea3296a67af3fd043bd4905d84 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Apr 2023 15:47:56 +0000 Subject: [PATCH 039/127] Remove files --- index.d.ts | 180 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6362 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index e182d3f..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 99373fd..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;6/BAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 06ba572..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 68a4222453a344a34408201788e2ee8a1fc21385 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Apr 2023 15:49:01 +0000 Subject: [PATCH 040/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 236 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 778 --- test/test.js | 40 - test/test.main.js | 657 --- test/test.validate.js | 160 - 46 files changed, 6208 insertions(+), 6030 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index ce5fd29..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-04-01T05:32:40.909Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 6b6dd87..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4061660 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..a66d01e --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 760c843..66081b7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-integer": "^0.0.8", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.8", - "@stdlib/assert-is-plain-object": "^0.0.7", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.7", - "@stdlib/ndarray-base-assert-is-order": "^0.0.7", - "@stdlib/ndarray-base-ind2sub": "^0.0.8", - "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.7", - "@stdlib/assert-is-array": "^0.0.7", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-special-floor": "^0.0.8", - "@stdlib/ndarray-base-numel": "^0.0.8", - "@stdlib/random-base-randu": "^0.0.8", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c66b8ed --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From f55449ad229ce7b48606622b40a9ebcc180b62d8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 May 2023 07:39:05 +0000 Subject: [PATCH 041/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 4095af0..760c843 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.7", "@stdlib/ndarray-base-ind2sub": "^0.0.8", "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" }, From 8157355face4cf9b534d46b8754f0e6e0f47a1c6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 May 2023 15:25:02 +0000 Subject: [PATCH 042/127] Remove files --- index.d.ts | 180 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6362 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4061660..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index a66d01e..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c66b8ed..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 035b1a61f512787fcd920894b25478047698e69e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 May 2023 15:26:01 +0000 Subject: [PATCH 043/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 236 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 778 --- test/test.js | 40 - test/test.main.js | 657 --- test/test.validate.js | 160 - 46 files changed, 6208 insertions(+), 6030 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 42dc33b..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-05-01T05:13:08.710Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 6b6dd87..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4061660 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..a66d01e --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 760c843..66081b7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-integer": "^0.0.8", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.8", - "@stdlib/assert-is-plain-object": "^0.0.7", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.7", - "@stdlib/ndarray-base-assert-is-order": "^0.0.7", - "@stdlib/ndarray-base-ind2sub": "^0.0.8", - "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.7", - "@stdlib/assert-is-array": "^0.0.7", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-special-floor": "^0.0.8", - "@stdlib/ndarray-base-numel": "^0.0.8", - "@stdlib/random-base-randu": "^0.0.8", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..86360f2 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 255860f43c9979a7d21367309e0a787a4eaf6272 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Jun 2023 07:32:45 +0000 Subject: [PATCH 044/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 4095af0..760c843 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.7", "@stdlib/ndarray-base-ind2sub": "^0.0.8", "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" }, From 1595212a8252cb0569cdf7b9c5d32eb7be6adae6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Jun 2023 15:46:39 +0000 Subject: [PATCH 045/127] Remove files --- index.d.ts | 180 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6362 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4061660..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index a66d01e..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 86360f2..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 805d7ccabb4330dd87208a8accdb021961174508 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Jun 2023 15:47:32 +0000 Subject: [PATCH 046/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 236 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 778 --- test/test.js | 40 - test/test.main.js | 657 --- test/test.validate.js | 160 - 46 files changed, 6208 insertions(+), 6030 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 3cfc259..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-06-01T04:47:41.396Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 6b6dd87..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4061660 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..a66d01e --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 760c843..66081b7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-integer": "^0.0.8", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.8", - "@stdlib/assert-is-plain-object": "^0.0.7", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.7", - "@stdlib/ndarray-base-assert-is-order": "^0.0.7", - "@stdlib/ndarray-base-ind2sub": "^0.0.8", - "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.7", - "@stdlib/assert-is-array": "^0.0.7", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-special-floor": "^0.0.8", - "@stdlib/ndarray-base-numel": "^0.0.8", - "@stdlib/random-base-randu": "^0.0.8", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..094c5db --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From fd1b2a5739e3b2bcf4eefc7fe09cbb7eb11e536a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Jul 2023 07:20:04 +0000 Subject: [PATCH 047/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 72a3b5a..e9fd19e 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,17 +81,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 815997b..5f2452f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,7 +73,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 4095af0..760c843 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.7", "@stdlib/ndarray-base-ind2sub": "^0.0.8", "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" }, From da727792f423c9eec91cf6cddccaf722806c2ed3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Jul 2023 16:05:43 +0000 Subject: [PATCH 048/127] Remove files --- index.d.ts | 180 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6362 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4061660..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index a66d01e..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 094c5db..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 0ff6bb997bac24f4418d5353970ac1efa0d41bc3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 1 Jul 2023 16:06:39 +0000 Subject: [PATCH 049/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 236 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 778 --- test/test.js | 40 - test/test.main.js | 657 --- test/test.validate.js | 160 - 46 files changed, 6208 insertions(+), 6030 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 8d1a286..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-07-01T04:45:15.160Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 6b6dd87..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v1 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4061660 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..a66d01e --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index e9fd19e..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 5f2452f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 760c843..66081b7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-integer": "^0.0.8", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.8", - "@stdlib/assert-is-plain-object": "^0.0.7", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.7", - "@stdlib/ndarray-base-assert-is-order": "^0.0.7", - "@stdlib/ndarray-base-ind2sub": "^0.0.8", - "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.7", - "@stdlib/assert-is-array": "^0.0.7", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-special-floor": "^0.0.8", - "@stdlib/ndarray-base-numel": "^0.0.8", - "@stdlib/random-base-randu": "^0.0.8", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d8bacd4 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From fdf811dca3bf19b445033851cb0721d928ee3a5e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Aug 2023 08:09:20 +0000 Subject: [PATCH 050/127] Transform error messages --- lib/assign.js | 8 ++++---- lib/main.js | 4 ++-- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 18f4778..997c899 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -80,17 +80,17 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0Mt5x', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0Mt5x', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/main.js b/lib/main.js index 9021ada..372e8b5 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -72,7 +72,7 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0Mt5y', shape ) ); } if ( !isInteger( idx ) ) { throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); diff --git a/lib/validate.js b/lib/validate.js index ee01d90..11d54fc 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0Mt2h', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0Mt61', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 4095af0..760c843 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.0.7", "@stdlib/ndarray-base-ind2sub": "^0.0.8", "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" }, From e24bf5ae3aabbf9e6d877bc58270b0ab4ab1280d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Aug 2023 16:54:15 +0000 Subject: [PATCH 051/127] Remove files --- index.d.ts | 180 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6362 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4061660..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index a66d01e..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d8bacd4..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From ce7946d2ff258f878f2c0e7dc89055c766d25c67 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Aug 2023 16:55:07 +0000 Subject: [PATCH 052/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 236 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - docs/repl.txt | 88 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 105 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 87 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 778 --- test/test.js | 40 - test/test.main.js | 657 --- test/test.validate.js | 160 - 46 files changed, 6208 insertions(+), 6028 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index b73c3f2..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-08-01T05:19:28.111Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 6b6dd87..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 334eb59..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -222,7 +221,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -284,11 +283,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 3e8f21a..f06b08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4061660 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..cb9ef33 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCTA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC9CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 997c899..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0Mt5x', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0Mt5x', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 372e8b5..0000000 --- a/lib/main.js +++ /dev/null @@ -1,87 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0Mt5y', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 11d54fc..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0Mt2h', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0Mt60', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0Mt61', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 760c843..66081b7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.7", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-integer": "^0.0.8", - "@stdlib/assert-is-nonnegative-integer-array": "^0.0.8", - "@stdlib/assert-is-plain-object": "^0.0.7", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.0.7", - "@stdlib/ndarray-base-assert-is-order": "^0.0.7", - "@stdlib/ndarray-base-ind2sub": "^0.0.8", - "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.0.7", - "@stdlib/assert-is-array": "^0.0.7", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-special-floor": "^0.0.8", - "@stdlib/ndarray-base-numel": "^0.0.8", - "@stdlib/random-base-randu": "^0.0.8", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..933d0d9 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From c26081fac46918a22aa4af06c7d6d346930ae483 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 23 Sep 2023 23:09:15 +0000 Subject: [PATCH 053/127] Transform error messages --- lib/assign.js | 10 +++++----- lib/main.js | 6 +++--- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 18f4778..bfaa3bf 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -80,20 +80,20 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0jx5j,LP', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0jx5j,LP', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k,LN', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l,LO', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len diff --git a/lib/main.js b/lib/main.js index 9021ada..bfd9e3f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -72,10 +72,10 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k,LN', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l,LO', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index ee01d90..b0a03e1 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0jx2V,FD', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0jx5n,LM', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 7abfce5..cf020cc 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.1.0", "@stdlib/ndarray-base-ind2sub": "^0.1.0", "@stdlib/ndarray-base-shape2strides": "^0.1.0", - "@stdlib/string-format": "^0.1.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.0", "@stdlib/types": "^0.1.0", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0" }, From e6359c7302193214c94cc0f91a8188699809de04 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 00:52:41 +0000 Subject: [PATCH 054/127] Remove files --- index.d.ts | 180 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6362 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index f06b08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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: 2.0 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4061660..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n,{assign as o}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@esm/index.mjs";var p="throw",h="row-major";function j(e,r){return i(r)?m(r,"mode")&&(e.mode=r.mode,!l(e.mode))?new TypeError(d("0Mt60","mode",e.mode)):m(r,"order")&&(e.order=r.order,!a(e.order))?new TypeError(d("0Mt61","order",e.order)):null:new TypeError(d("0Mt2h",r))}function f(e,o,i){var m,a;if((m={}).mode=p,m.order=h,arguments.length>2&&(a=j(m,i)))throw a;if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(o))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",o));return n(e,s(e,m.order),0,m.order,o,m.mode)}function g(e,n,i,m){var a,l,f;if((a={}).mode=p,a.order=h,4===arguments.length){if(f=j(a,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(d("0Mt5x",m));l=m}else if("object"!=typeof(l=i)||null===l)throw new TypeError(d("0Mt5x",l));if(!r(e))throw new TypeError(d("0Mt5y",e));if(!t(n))throw new TypeError(d("invalid argument. Linear index must be integer valued. Value: `%s`.",n));return o(e,s(e,a.order),0,a.order,n,a.mode,l)}e(f,"assign",g);export{g as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index cb9ef33..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0Mt2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0Mt60', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0Mt61', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0Mt5x', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0Mt5y', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;ogCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCTA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC9CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 933d0d9..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From f0f12083e5688add5e8179c3f3246b985ad04a09 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 00:54:30 +0000 Subject: [PATCH 055/127] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 783 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 236 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 88 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 105 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 87 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 778 --- test/test.js | 40 - test/test.main.js | 657 --- test/test.validate.js | 160 - 49 files changed, 6208 insertions(+), 6066 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index e9df8d8..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 6b6dd87..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 91f2b93..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,783 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -233,7 +232,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -295,11 +294,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index d61db64..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAgCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICtFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAwCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC1DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 06bb6c0..fe7cd2d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..66d82d3 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.0-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.0-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.0-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m,LL","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n,LM","order",r.order)):null:new TypeError(n("0jx2V,FD",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(d))throw new TypeError(n("0jx5l,LO",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j,LP",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j,LP",p));if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(o))throw new TypeError(n("0jx5l,LO",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..e2ac06c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n,LM', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;qjCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,WAAY,OAAQP,EAAKI,OAGpDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,WAAY,QAASP,EAAKQ,QAGnD,KAdC,IAAIF,UAAWC,EAAQ,WAAYN,GAe5C,CCTA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,WAAYc,IAE1CC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,WAAYe,IAG3C,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC9CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index bfaa3bf..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j,LP', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j,LP', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k,LN', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l,LO', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index bfd9e3f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,87 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k,LN', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l,LO', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index b0a03e1..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V,FD', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n,LM', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index cf020cc..5796df9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.1.0", - "@stdlib/assert-is-integer": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer-array": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.0", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.1.0", - "@stdlib/ndarray-base-assert-is-order": "^0.1.0", - "@stdlib/ndarray-base-ind2sub": "^0.1.0", - "@stdlib/ndarray-base-shape2strides": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.0", - "@stdlib/types": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.1.0", - "@stdlib/assert-is-array": "^0.1.0", - "@stdlib/bench": "^0.1.0", - "@stdlib/math-base-special-floor": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.0", - "@stdlib/random-base-randu": "^0.0.8", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..2be2c3e --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From c9ff18043661ef11f77811ebdef94aea17b3888f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 01:33:49 +0000 Subject: [PATCH 056/127] Update README.md for ESM bundle v0.1.0 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e63ee87..a4e7e15 100644 --- a/README.md +++ b/README.md @@ -52,13 +52,13 @@ limitations under the License. ## Usage ```javascript -import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; +import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@v0.1.0-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@v0.1.0-esm/index.mjs'; ``` #### ind2sub( shape, idx\[, options] ) @@ -152,7 +152,7 @@ The function accepts the same `options` as above. - - - - From 89f853234471c6903cd7b3771e0e6fb8208d2b6c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Oct 2023 16:13:37 +0000 Subject: [PATCH 060/127] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 247 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 236 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 88 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 105 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 87 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 40 - test/test.assign.js | 778 --- test/test.js | 40 - test/test.main.js | 657 --- test/test.validate.js | 160 - 51 files changed, 6208 insertions(+), 6165 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 0c5e23c..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-10-01T03:24:44.774Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c12b2a2..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -233,7 +232,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -295,11 +294,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index d61db64..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAgCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICtFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAwCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC1DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 06bb6c0..fe7cd2d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..0ec4cdf --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.0-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.0-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.0-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m,LL","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n,LM","order",r.order)):null:new TypeError(n("0jx2V,FD",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(d))throw new TypeError(n("0jx5l,LO",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j,LP",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j,LP",p));if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(o))throw new TypeError(n("0jx5l,LO",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..099958b --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n,LM', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,WAAY,OAAQP,EAAKI,OAGpDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,WAAY,QAASP,EAAKQ,QAGnD,KAdC,IAAIF,UAAWC,EAAQ,WAAYN,GAe5C,CCTA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,WAAYc,IAE1CC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,WAAYe,IAG3C,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC9CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index bfaa3bf..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j,LP', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j,LP', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k,LN', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l,LO', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index bfd9e3f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,87 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k,LN', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l,LO', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index b0a03e1..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V,FD', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n,LM', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 2a7d519..5796df9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.1.0", - "@stdlib/assert-is-integer": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer-array": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.0", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.1.0", - "@stdlib/ndarray-base-assert-is-order": "^0.1.0", - "@stdlib/ndarray-base-ind2sub": "^0.1.0", - "@stdlib/ndarray-base-shape2strides": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.0", - "@stdlib/types": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.1.0", - "@stdlib/assert-is-array": "^0.1.0", - "@stdlib/bench": "^0.1.0", - "@stdlib/math-base-special-floor": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.0", - "@stdlib/random-base-randu": "^0.1.0", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..176f12c --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index 85b4519..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 40409ff63827cdf28d8202c1db69e2321735c4ae Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 5 Oct 2023 13:54:18 +0000 Subject: [PATCH 061/127] Transform error messages --- lib/assign.js | 10 +++++----- lib/main.js | 6 +++--- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index 18f4778..bfaa3bf 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -80,20 +80,20 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0jx5j,LP', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0jx5j,LP', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k,LN', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l,LO', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len diff --git a/lib/main.js b/lib/main.js index 9021ada..bfd9e3f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -72,10 +72,10 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k,LN', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l,LO', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index ee01d90..b0a03e1 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0jx2V,FD', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0jx5n,LM', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index c3c2686..df86acf 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.1.1", "@stdlib/ndarray-base-ind2sub": "^0.1.0", "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.1.0", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" }, From 07185a9b4b2e658dd31d843f6879dd9e6c91c45d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 6 Oct 2023 17:32:21 +0000 Subject: [PATCH 062/127] Remove files --- index.d.ts | 180 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6362 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index fe7cd2d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0ec4cdf..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.0-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.0-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.0-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m,LL","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n,LM","order",r.order)):null:new TypeError(n("0jx2V,FD",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(d))throw new TypeError(n("0jx5l,LO",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j,LP",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j,LP",p));if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(o))throw new TypeError(n("0jx5l,LO",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 099958b..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n,LM', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,WAAY,OAAQP,EAAKI,OAGpDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,WAAY,QAASP,EAAKQ,QAGnD,KAdC,IAAIF,UAAWC,EAAQ,WAAYN,GAe5C,CCTA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,WAAYc,IAE1CC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,WAAYe,IAG3C,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC9CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 176f12c..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 99fde33a06aa8c5efb504826083f2e4763848a4a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 6 Oct 2023 17:35:17 +0000 Subject: [PATCH 063/127] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 247 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 236 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 88 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 105 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 87 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 40 - test/test.assign.js | 778 --- test/test.js | 40 - test/test.main.js | 657 --- test/test.validate.js | 160 - 50 files changed, 6208 insertions(+), 6164 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c12b2a2..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -233,7 +232,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -295,11 +294,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index d61db64..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAgCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICtFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAwCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC1DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 06bb6c0..fe7cd2d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d3aeafd --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m,LL","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n,LM","order",r.order)):null:new TypeError(n("0jx2V,FD",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(d))throw new TypeError(n("0jx5l,LO",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j,LP",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j,LP",p));if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(o))throw new TypeError(n("0jx5l,LO",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..099958b --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n,LM', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,WAAY,OAAQP,EAAKI,OAGpDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,WAAY,QAASP,EAAKQ,QAGnD,KAdC,IAAIF,UAAWC,EAAQ,WAAYN,GAe5C,CCTA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,WAAYc,IAE1CC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,WAAYe,IAG3C,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC9CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index bfaa3bf..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j,LP', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j,LP', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k,LN', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l,LO', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index bfd9e3f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,87 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k,LN', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l,LO', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index b0a03e1..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V,FD', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n,LM', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index df86acf..5796df9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-integer": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer-array": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.1.1", - "@stdlib/ndarray-base-assert-is-order": "^0.1.1", - "@stdlib/ndarray-base-ind2sub": "^0.1.0", - "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.1.0", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/bench": "^0.1.0", - "@stdlib/math-base-special-floor": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-randu": "^0.1.0", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f35fad9 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index 85b4519..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 05c3fe0947be6899835001b392443876bf96c2be Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 10 Oct 2023 19:09:10 +0000 Subject: [PATCH 064/127] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 44f1176..ca59834 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.1.1", "@stdlib/ndarray-base-ind2sub": "^0.1.1", "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.1.0", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" }, From 07a3b2989436c607f8eb2ea9ad972c09ffb6468e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 10 Oct 2023 20:44:31 +0000 Subject: [PATCH 065/127] Remove files --- index.d.ts | 180 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6362 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index fe7cd2d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d3aeafd..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m,LL","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n,LM","order",r.order)):null:new TypeError(n("0jx2V,FD",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(d))throw new TypeError(n("0jx5l,LO",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j,LP",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j,LP",p));if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(o))throw new TypeError(n("0jx5l,LO",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 099958b..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n,LM', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,WAAY,OAAQP,EAAKI,OAGpDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,WAAY,QAASP,EAAKQ,QAGnD,KAdC,IAAIF,UAAWC,EAAQ,WAAYN,GAe5C,CCTA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,WAAYc,IAE1CC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,WAAYe,IAG3C,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC9CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f35fad9..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 318f25b77c96e8289eb74590384fddf3bd219220 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 10 Oct 2023 20:48:07 +0000 Subject: [PATCH 066/127] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 247 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 236 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 88 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 105 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 87 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 40 - test/test.assign.js | 778 --- test/test.js | 40 - test/test.main.js | 657 --- test/test.validate.js | 160 - 50 files changed, 6208 insertions(+), 6164 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c12b2a2..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -233,7 +232,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -295,11 +294,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index d61db64..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAgCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICtFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAwCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC1DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 06bb6c0..fe7cd2d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d122e75 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import s,{assign as i}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",u="row-major";function g(e,r){return d(r)?a(r,"mode")&&(e.mode=r.mode,!p(e.mode))?new TypeError(o("invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.","mode",e.mode)):a(r,"order")&&(e.order=r.order,!m(e.order))?new TypeError(o("invalid option. `%s` option must be a supported/recognized order. Option: `%s`.","order",e.order)):null:new TypeError(o("invalid argument. Options argument must be an object. Value: `%s`.",r))}function j(e,i,d){var a,m;if((a={}).mode=l,a.order=u,arguments.length>2&&(m=g(a,d)))throw m;if(!r(e))throw new TypeError(o("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!t(i))throw new TypeError(o("invalid argument. Linear index must be integer valued. Value: `%s`.",i));return s(e,n(e,a.order),0,a.order,i,a.mode)}function h(e,s,d,a){var m,p,j;if((m={}).mode=l,m.order=u,4===arguments.length){if(j=g(m,arguments[2]))throw j;if("object"!=typeof a||null===a)throw new TypeError(o("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",a));p=a}else if("object"!=typeof(p=d)||null===p)throw new TypeError(o("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",p));if(!r(e))throw new TypeError(o("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!t(s))throw new TypeError(o("invalid argument. Linear index must be integer valued. Value: `%s`.",s));return i(e,n(e,m.order),0,m.order,s,m.mode,p)}e(j,"assign",h);export{h as assign,j as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..834a10e --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;0jCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,iFAAkF,OAAQP,EAAKI,OAG1HD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,kFAAmF,QAASP,EAAKQ,QAG1H,KAdC,IAAIF,UAAWC,EAAQ,qEAAsEN,GAetG,CCTA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,8GAA+GI,IAE7I,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,kGAAmGc,IAEjIC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,kGAAmGe,IAGlI,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,8GAA+GI,IAE7I,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC9CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 18f4778..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 9021ada..0000000 --- a/lib/main.js +++ /dev/null @@ -1,87 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index ee01d90..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index ca59834..1967056 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-integer": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer-array": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.1.1", - "@stdlib/ndarray-base-assert-is-order": "^0.1.1", - "@stdlib/ndarray-base-ind2sub": "^0.1.1", - "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/bench": "^0.1.0", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-randu": "^0.1.0", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..2c4fa85 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index 85b4519..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From ce26885f92da1aee11e8170f8126778d9c77bc03 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 10 Oct 2023 21:59:15 +0000 Subject: [PATCH 067/127] Update README.md for ESM bundle v0.1.1 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 21e007c..5c27d29 100644 --- a/README.md +++ b/README.md @@ -52,13 +52,13 @@ limitations under the License. ## Usage ```javascript -import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; +import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@v0.1.1-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@v0.1.1-esm/index.mjs'; ``` #### ind2sub( shape, idx\[, options] ) @@ -152,7 +152,7 @@ The function accepts the same `options` as above. - - - - From 20aaa61e782ca37037d5f52389d99cf580ccda48 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 2 Nov 2023 16:58:07 +0000 Subject: [PATCH 071/127] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 236 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 88 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 105 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 87 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 778 --- test/test.js | 40 - test/test.main.js | 657 --- test/test.validate.js | 160 - 51 files changed, 6208 insertions(+), 6166 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index a4d8e9c..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-11-01T03:34:02.941Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c12b2a2..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -233,7 +232,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -295,11 +294,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 2fa559c..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,236 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index d61db64..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAgCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICtFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAwCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC1DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index f4f74ce..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,88 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'wrap', the function wraps around - a linear index exceeding array dimensions using modulo arithmetic. If - equal to 'clamp', the function sets a linear index exceeding array - dimensions to either `0` (minimum linear index) or the maximum linear - index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index be3ea2a..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType number[] - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType number[] -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 06bb6c0..fe7cd2d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..cc6049f --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m,LL","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n,LM","order",r.order)):null:new TypeError(n("0jx2V,FD",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(d))throw new TypeError(n("0jx5l,LO",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j,LP",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j,LP",p));if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(o))throw new TypeError(n("0jx5l,LO",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..099958b --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n,LM', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,WAAY,OAAQP,EAAKI,OAGpDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,WAAY,QAASP,EAAKQ,QAGnD,KAdC,IAAIF,UAAWC,EAAQ,WAAYN,GAe5C,CCTA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,WAAYc,IAE1CC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,WAAYe,IAG3C,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC9CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index bfaa3bf..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j,LP', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j,LP', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k,LN', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l,LO', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index bfd9e3f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,87 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k,LN', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l,LO', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index b0a03e1..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V,FD', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n,LM', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index ca59834..1967056 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-integer": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer-array": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.1.1", - "@stdlib/ndarray-base-assert-is-order": "^0.1.1", - "@stdlib/ndarray-base-ind2sub": "^0.1.1", - "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/bench": "^0.1.0", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-randu": "^0.1.0", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..ecc584a --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 6dea702..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,778 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 611286c..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,657 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 2e8815369bd7ed094952d139742c7a03dce28c7e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 25 Nov 2023 07:30:15 +0000 Subject: [PATCH 072/127] Transform error messages --- lib/assign.js | 10 +++++----- lib/main.js | 6 +++--- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index f9ee6b2..8d33b51 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,20 +81,20 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0jx5j,LP', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0jx5j,LP', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k,LN', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l,LO', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len diff --git a/lib/main.js b/lib/main.js index 58fdf93..f24b685 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,10 +73,10 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k,LN', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l,LO', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index ee01d90..b0a03e1 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0jx2V,FD', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0jx5n,LM', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 571da64..8e58b70 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.1.1", "@stdlib/ndarray-base-ind2sub": "^0.1.1", "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" }, From d679c6a50dc4e4ea9128aef436f41fe18d251861 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 25 Nov 2023 07:33:47 +0000 Subject: [PATCH 073/127] Remove files --- index.d.ts | 180 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6362 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index fe7cd2d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: any ): Array; // tslint-disable-line max-line-length - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - `throw`: throws an error when a linear index exceeds array dimensions. - * - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: any ): Array; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - `throw`: throws an error when a linear index exceeds array dimensions. -* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index cc6049f..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m,LL","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n,LM","order",r.order)):null:new TypeError(n("0jx2V,FD",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(d))throw new TypeError(n("0jx5l,LO",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j,LP",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j,LP",p));if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(o))throw new TypeError(n("0jx5l,LO",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 099958b..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n,LM', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - `throw`: throws an error when a linear index exceeds array dimensions.\n* - `wrap`: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - `clamp`: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,WAAY,OAAQP,EAAKI,OAGpDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,WAAY,QAASP,EAAKQ,QAGnD,KAdC,IAAIF,UAAWC,EAAQ,WAAYN,GAe5C,CCTA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,WAAYc,IAE1CC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,WAAYe,IAG3C,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC9CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index ecc584a..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From cfea1d4dcfaba9b7e8757e092b3e030f3c6ec5e0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 25 Nov 2023 07:36:04 +0000 Subject: [PATCH 074/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 266 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 --- test/test.js | 40 - test/test.main.js | 752 --- test/test.validate.js | 160 - 50 files changed, 6208 insertions(+), 6392 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c12b2a2..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -234,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -296,11 +295,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 8d2a89e..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 9a12046..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0dcfa02..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 7c52e15..2893e0b 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..cc6049f --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m,LL","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n,LM","order",r.order)):null:new TypeError(n("0jx2V,FD",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(d))throw new TypeError(n("0jx5l,LO",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j,LP",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j,LP",p));if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(o))throw new TypeError(n("0jx5l,LO",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..c2ab50d --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n,LM', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,WAAY,OAAQP,EAAKI,OAGpDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,WAAY,QAASP,EAAKQ,QAGnD,KAdC,IAAIF,UAAWC,EAAQ,WAAYN,GAe5C,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,WAAYc,IAE1CC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,WAAYe,IAG3C,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 8d33b51..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j,LP', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j,LP', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k,LN', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l,LO', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index f24b685..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k,LN', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l,LO', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index b0a03e1..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V,FD', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n,LM', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 8e58b70..1967056 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-integer": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer-array": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.1.1", - "@stdlib/ndarray-base-assert-is-order": "^0.1.1", - "@stdlib/ndarray-base-ind2sub": "^0.1.1", - "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/bench": "^0.2.1", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-randu": "^0.1.0", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..a58ec67 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b505b85..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 84a573268c18bd20a74d768d03cd35e4abca1c7e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 25 Nov 2023 10:39:43 +0000 Subject: [PATCH 075/127] Transform error messages --- lib/assign.js | 10 +++++----- lib/main.js | 6 +++--- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index f9ee6b2..8d33b51 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,20 +81,20 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0jx5j,LP', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0jx5j,LP', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k,LN', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l,LO', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len diff --git a/lib/main.js b/lib/main.js index 58fdf93..f24b685 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,10 +73,10 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k,LN', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l,LO', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index ee01d90..b0a03e1 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0jx2V,FD', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0jx5n,LM', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 571da64..8e58b70 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.1.1", "@stdlib/ndarray-base-ind2sub": "^0.1.1", "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" }, From 44df236548b60daacd04eb5596fe70d1b171e7d7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 25 Nov 2023 10:40:08 +0000 Subject: [PATCH 076/127] Remove files --- index.d.ts | 180 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6362 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 2893e0b..0000000 --- a/index.d.ts +++ /dev/null @@ -1,180 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: ArrayLike ): ArrayLike; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: ArrayLike ): ArrayLike; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index cc6049f..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m,LL","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n,LM","order",r.order)):null:new TypeError(n("0jx2V,FD",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(d))throw new TypeError(n("0jx5l,LO",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j,LP",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j,LP",p));if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(o))throw new TypeError(n("0jx5l,LO",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index c2ab50d..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n,LM', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,WAAY,OAAQP,EAAKI,OAGpDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,WAAY,QAASP,EAAKQ,QAGnD,KAdC,IAAIF,UAAWC,EAAQ,WAAYN,GAe5C,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,WAAYc,IAE1CC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,WAAYe,IAG3C,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a58ec67..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 8b3a77c3285724be56570e334da69b35ba2fc6d5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 25 Nov 2023 10:42:29 +0000 Subject: [PATCH 077/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 266 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 --- test/test.js | 40 - test/test.main.js | 752 --- test/test.validate.js | 160 - 50 files changed, 6208 insertions(+), 6392 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c12b2a2..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -234,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -296,11 +295,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 8d2a89e..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 9a12046..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0dcfa02..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..cc6049f --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m,LL","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n,LM","order",r.order)):null:new TypeError(n("0jx2V,FD",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(d))throw new TypeError(n("0jx5l,LO",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j,LP",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j,LP",p));if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(o))throw new TypeError(n("0jx5l,LO",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..c2ab50d --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n,LM', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,WAAY,OAAQP,EAAKI,OAGpDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,WAAY,QAASP,EAAKQ,QAGnD,KAdC,IAAIF,UAAWC,EAAQ,WAAYN,GAe5C,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,WAAYc,IAE1CC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,WAAYe,IAG3C,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 8d33b51..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j,LP', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j,LP', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k,LN', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l,LO', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index f24b685..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k,LN', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l,LO', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index b0a03e1..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V,FD', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n,LM', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 8e58b70..1967056 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-integer": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer-array": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.1.1", - "@stdlib/ndarray-base-assert-is-order": "^0.1.1", - "@stdlib/ndarray-base-ind2sub": "^0.1.1", - "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/bench": "^0.2.1", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-randu": "^0.1.0", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..218d5dd --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b505b85..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From f1ff6cb7899b205bea73fc91dc33a14712eab9dc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Dec 2023 14:05:44 +0000 Subject: [PATCH 078/127] Transform error messages --- lib/assign.js | 10 +++++----- lib/main.js | 6 +++--- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index f9ee6b2..8d33b51 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,20 +81,20 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0jx5j,LP', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0jx5j,LP', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k,LN', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l,LO', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len diff --git a/lib/main.js b/lib/main.js index 58fdf93..f24b685 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,10 +73,10 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k,LN', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l,LO', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index ee01d90..b0a03e1 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0jx2V,FD', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0jx5n,LM', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 571da64..8e58b70 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.1.1", "@stdlib/ndarray-base-ind2sub": "^0.1.1", "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" }, From 13794a9a51dc61f4ce4466c7408cf4230513af71 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 12:28:08 +0000 Subject: [PATCH 079/127] Remove files --- index.d.ts | 184 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6366 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 85258d7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -/** -* Interface describing the main export. -*/ -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: ArrayLike ): ArrayLike; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: ArrayLike ): ArrayLike; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index cc6049f..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m,LL","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n,LM","order",r.order)):null:new TypeError(n("0jx2V,FD",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(d))throw new TypeError(n("0jx5l,LO",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j,LP",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j,LP",p));if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(o))throw new TypeError(n("0jx5l,LO",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index c2ab50d..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n,LM', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,WAAY,OAAQP,EAAKI,OAGpDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,WAAY,QAASP,EAAKQ,QAGnD,KAdC,IAAIF,UAAWC,EAAQ,WAAYN,GAe5C,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,WAAYc,IAE1CC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,WAAYe,IAG3C,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 218d5dd..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From aec01a017adce229871888362d3a0e529f54ebef Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 12:30:23 +0000 Subject: [PATCH 080/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- benchmark/benchmark.js | 266 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 --- test/test.js | 40 - test/test.main.js | 752 --- test/test.validate.js | 160 - 51 files changed, 6208 insertions(+), 6393 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index e5864dc..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-12-01T05:57:19.468Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c12b2a2..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -234,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -296,11 +295,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 8d2a89e..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 9a12046..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0dcfa02..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..cc6049f --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m,LL","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n,LM","order",r.order)):null:new TypeError(n("0jx2V,FD",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(d))throw new TypeError(n("0jx5l,LO",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j,LP",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j,LP",p));if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(o))throw new TypeError(n("0jx5l,LO",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..c2ab50d --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n,LM', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,WAAY,OAAQP,EAAKI,OAGpDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,WAAY,QAASP,EAAKQ,QAGnD,KAdC,IAAIF,UAAWC,EAAQ,WAAYN,GAe5C,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,WAAYc,IAE1CC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,WAAYe,IAG3C,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 8d33b51..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j,LP', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j,LP', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k,LN', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l,LO', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index f24b685..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k,LN', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l,LO', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index b0a03e1..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V,FD', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n,LM', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 8e58b70..1967056 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-integer": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer-array": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.1.1", - "@stdlib/ndarray-base-assert-is-order": "^0.1.1", - "@stdlib/ndarray-base-ind2sub": "^0.1.1", - "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/bench": "^0.2.1", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-randu": "^0.1.0", - "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", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..83c0248 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b505b85..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From bfa77768137874a86a6fdf2d633c1100ce781379 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 08:27:14 +0000 Subject: [PATCH 081/127] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index d28b0a0..fcb4404 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.1.1", "@stdlib/ndarray-base-ind2sub": "^0.1.1", "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" }, From 5e5e9a6f6de19f4118f975abd1789dac7a2f4c98 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 15:03:05 +0000 Subject: [PATCH 082/127] Remove files --- index.d.ts | 184 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6366 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 85258d7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -/** -* Interface describing the main export. -*/ -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: ArrayLike ): ArrayLike; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: ArrayLike ): ArrayLike; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index cc6049f..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m,LL","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n,LM","order",r.order)):null:new TypeError(n("0jx2V,FD",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(d))throw new TypeError(n("0jx5l,LO",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j,LP",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j,LP",p));if(!e(r))throw new TypeError(n("0jx5k,LN",r));if(!s(o))throw new TypeError(n("0jx5l,LO",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index c2ab50d..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m,LL', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n,LM', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j,LP', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k,LN', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l,LO', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,WAAY,OAAQP,EAAKI,OAGpDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,WAAY,QAASP,EAAKQ,QAGnD,KAdC,IAAIF,UAAWC,EAAQ,WAAYN,GAe5C,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,WAAYc,IAE1CC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,WAAYe,IAG3C,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,WAAYI,IAE1C,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,WAAYK,IAG1C,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 83c0248..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From f2fb171b0f0037fa23ae15df9af768c3c4f34507 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 15:03:30 +0000 Subject: [PATCH 083/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 266 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 --- test/test.js | 40 - test/test.main.js | 752 --- test/test.validate.js | 160 - 52 files changed, 6208 insertions(+), 6399 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index ceb82a9..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-01-01T05:27:13.722Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 10ab7cf..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -234,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -296,11 +295,11 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 6f0e1b5..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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-harness' ); -var randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 5bd8154..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 9a12046..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0dcfa02..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7f97ba4 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import s,{assign as i}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",u="row-major";function g(e,r){return d(r)?a(r,"mode")&&(e.mode=r.mode,!p(e.mode))?new TypeError(o("invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.","mode",e.mode)):a(r,"order")&&(e.order=r.order,!m(e.order))?new TypeError(o("invalid option. `%s` option must be a supported/recognized order. Option: `%s`.","order",e.order)):null:new TypeError(o("invalid argument. Options argument must be an object. Value: `%s`.",r))}function j(e,i,d){var a,m;if((a={}).mode=l,a.order=u,arguments.length>2&&(m=g(a,d)))throw m;if(!r(e))throw new TypeError(o("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!t(i))throw new TypeError(o("invalid argument. Linear index must be integer valued. Value: `%s`.",i));return s(e,n(e,a.order),0,a.order,i,a.mode)}function h(e,s,d,a){var m,p,j;if((m={}).mode=l,m.order=u,4===arguments.length){if(j=g(m,arguments[2]))throw j;if("object"!=typeof a||null===a)throw new TypeError(o("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",a));p=a}else if("object"!=typeof(p=d)||null===p)throw new TypeError(o("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",p));if(!r(e))throw new TypeError(o("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!t(s))throw new TypeError(o("invalid argument. Linear index must be integer valued. Value: `%s`.",s));return i(e,n(e,m.order),0,m.order,s,m.mode,p)}e(j,"assign",h);export{h as assign,j as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..f02adad --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;0jCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,iFAAkF,OAAQP,EAAKI,OAG1HD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,kFAAmF,QAASP,EAAKQ,QAG1H,KAdC,IAAIF,UAAWC,EAAQ,qEAAsEN,GAetG,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,8GAA+GI,IAE7I,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,kGAAmGc,IAEjIC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,kGAAmGe,IAGlI,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,8GAA+GI,IAE7I,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index f9ee6b2..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 58fdf93..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index ee01d90..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index fcb4404..1967056 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-integer": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer-array": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.1.1", - "@stdlib/ndarray-base-assert-is-order": "^0.1.1", - "@stdlib/ndarray-base-ind2sub": "^0.1.1", - "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-randu": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..7c8f3ee --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b505b85..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From a6fc36144ce9a2db6b2270542091caf8b8911cfc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 09:04:39 +0000 Subject: [PATCH 084/127] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index d28b0a0..fcb4404 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.1.1", "@stdlib/ndarray-base-ind2sub": "^0.1.1", "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" }, From 9f9d42d220e15f45487477451bc94516f61eab4c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 14:27:47 +0000 Subject: [PATCH 085/127] Remove files --- index.d.ts | 184 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6366 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 85258d7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -/** -* Interface describing the main export. -*/ -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: ArrayLike ): ArrayLike; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: ArrayLike ): ArrayLike; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7f97ba4..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import s,{assign as i}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",u="row-major";function g(e,r){return d(r)?a(r,"mode")&&(e.mode=r.mode,!p(e.mode))?new TypeError(o("invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.","mode",e.mode)):a(r,"order")&&(e.order=r.order,!m(e.order))?new TypeError(o("invalid option. `%s` option must be a supported/recognized order. Option: `%s`.","order",e.order)):null:new TypeError(o("invalid argument. Options argument must be an object. Value: `%s`.",r))}function j(e,i,d){var a,m;if((a={}).mode=l,a.order=u,arguments.length>2&&(m=g(a,d)))throw m;if(!r(e))throw new TypeError(o("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!t(i))throw new TypeError(o("invalid argument. Linear index must be integer valued. Value: `%s`.",i));return s(e,n(e,a.order),0,a.order,i,a.mode)}function h(e,s,d,a){var m,p,j;if((m={}).mode=l,m.order=u,4===arguments.length){if(j=g(m,arguments[2]))throw j;if("object"!=typeof a||null===a)throw new TypeError(o("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",a));p=a}else if("object"!=typeof(p=d)||null===p)throw new TypeError(o("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",p));if(!r(e))throw new TypeError(o("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!t(s))throw new TypeError(o("invalid argument. Linear index must be integer valued. Value: `%s`.",s));return i(e,n(e,m.order),0,m.order,s,m.mode,p)}e(j,"assign",h);export{h as assign,j as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index f02adad..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;0jCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,iFAAkF,OAAQP,EAAKI,OAG1HD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,kFAAmF,QAASP,EAAKQ,QAG1H,KAdC,IAAIF,UAAWC,EAAQ,qEAAsEN,GAetG,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,8GAA+GI,IAE7I,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,kGAAmGc,IAEjIC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,kGAAmGe,IAGlI,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,8GAA+GI,IAE7I,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 7c8f3ee..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 2829831fd7cbb84ac2d31f7586f78b3772b1df48 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 14:28:05 +0000 Subject: [PATCH 086/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 266 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 --- test/test.js | 40 - test/test.main.js | 752 --- test/test.validate.js | 160 - 52 files changed, 6208 insertions(+), 6404 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 0c7e509..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-02-01T06:21:38.498Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 10ab7cf..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -236,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -301,11 +298,11 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 6f0e1b5..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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-harness' ); -var randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 1e236b2..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 9a12046..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0dcfa02..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7f97ba4 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import s,{assign as i}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",u="row-major";function g(e,r){return d(r)?a(r,"mode")&&(e.mode=r.mode,!p(e.mode))?new TypeError(o("invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.","mode",e.mode)):a(r,"order")&&(e.order=r.order,!m(e.order))?new TypeError(o("invalid option. `%s` option must be a supported/recognized order. Option: `%s`.","order",e.order)):null:new TypeError(o("invalid argument. Options argument must be an object. Value: `%s`.",r))}function j(e,i,d){var a,m;if((a={}).mode=l,a.order=u,arguments.length>2&&(m=g(a,d)))throw m;if(!r(e))throw new TypeError(o("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!t(i))throw new TypeError(o("invalid argument. Linear index must be integer valued. Value: `%s`.",i));return s(e,n(e,a.order),0,a.order,i,a.mode)}function h(e,s,d,a){var m,p,j;if((m={}).mode=l,m.order=u,4===arguments.length){if(j=g(m,arguments[2]))throw j;if("object"!=typeof a||null===a)throw new TypeError(o("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",a));p=a}else if("object"!=typeof(p=d)||null===p)throw new TypeError(o("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",p));if(!r(e))throw new TypeError(o("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!t(s))throw new TypeError(o("invalid argument. Linear index must be integer valued. Value: `%s`.",s));return i(e,n(e,m.order),0,m.order,s,m.mode,p)}e(j,"assign",h);export{h as assign,j as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..f02adad --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;0jCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,iFAAkF,OAAQP,EAAKI,OAG1HD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,kFAAmF,QAASP,EAAKQ,QAG1H,KAdC,IAAIF,UAAWC,EAAQ,qEAAsEN,GAetG,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,8GAA+GI,IAE7I,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,kGAAmGc,IAEjIC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,kGAAmGe,IAGlI,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,8GAA+GI,IAE7I,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index f9ee6b2..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 58fdf93..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index ee01d90..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index fcb4404..1967056 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-integer": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer-array": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.1.1", - "@stdlib/ndarray-base-assert-is-order": "^0.1.1", - "@stdlib/ndarray-base-ind2sub": "^0.1.1", - "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-randu": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..892b5df --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b505b85..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From f644b7d2f8a2c43bcef887916f88d0a30fce3c96 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 01:12:28 +0000 Subject: [PATCH 087/127] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index a72955c..4413df4 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.2.0", "@stdlib/ndarray-base-ind2sub": "^0.2.0", "@stdlib/ndarray-base-shape2strides": "^0.2.0", - "@stdlib/string-format": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.2.0", "@stdlib/types": "^0.3.1", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0" }, From 0bfa86e28f40521ffa26181b8b052b10b253b3d8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 04:47:26 +0000 Subject: [PATCH 088/127] Remove files --- index.d.ts | 184 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6366 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 85258d7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -/** -* Interface describing the main export. -*/ -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: ArrayLike ): ArrayLike; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: ArrayLike ): ArrayLike; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7f97ba4..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import s,{assign as i}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.1.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",u="row-major";function g(e,r){return d(r)?a(r,"mode")&&(e.mode=r.mode,!p(e.mode))?new TypeError(o("invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.","mode",e.mode)):a(r,"order")&&(e.order=r.order,!m(e.order))?new TypeError(o("invalid option. `%s` option must be a supported/recognized order. Option: `%s`.","order",e.order)):null:new TypeError(o("invalid argument. Options argument must be an object. Value: `%s`.",r))}function j(e,i,d){var a,m;if((a={}).mode=l,a.order=u,arguments.length>2&&(m=g(a,d)))throw m;if(!r(e))throw new TypeError(o("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!t(i))throw new TypeError(o("invalid argument. Linear index must be integer valued. Value: `%s`.",i));return s(e,n(e,a.order),0,a.order,i,a.mode)}function h(e,s,d,a){var m,p,j;if((m={}).mode=l,m.order=u,4===arguments.length){if(j=g(m,arguments[2]))throw j;if("object"!=typeof a||null===a)throw new TypeError(o("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",a));p=a}else if("object"!=typeof(p=d)||null===p)throw new TypeError(o("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",p));if(!r(e))throw new TypeError(o("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!t(s))throw new TypeError(o("invalid argument. Linear index must be integer valued. Value: `%s`.",s));return i(e,n(e,m.order),0,m.order,s,m.mode,p)}e(j,"assign",h);export{h as assign,j as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index f02adad..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;0jCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,iFAAkF,OAAQP,EAAKI,OAG1HD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,kFAAmF,QAASP,EAAKQ,QAG1H,KAdC,IAAIF,UAAWC,EAAQ,qEAAsEN,GAetG,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,8GAA+GI,IAE7I,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,kGAAmGc,IAEjIC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,kGAAmGe,IAGlI,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,8GAA+GI,IAE7I,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 892b5df..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From ee595d6e6d5fd8008acb4ec7b3f609f7b57e1473 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 04:48:26 +0000 Subject: [PATCH 089/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 266 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 --- test/test.js | 40 - test/test.main.js | 752 --- test/test.validate.js | 160 - 51 files changed, 6208 insertions(+), 6407 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 0f75bbf..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -236,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -301,11 +298,11 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 6f0e1b5..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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-harness' ); -var randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 1e236b2..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 9a12046..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0dcfa02..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..94110dd --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.0-esm/index.mjs";import s,{assign as i}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.1.1-esm/index.mjs";var l="throw",u="row-major";function g(e,r){return d(r)?a(r,"mode")&&(e.mode=r.mode,!p(e.mode))?new TypeError(o("invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.","mode",e.mode)):a(r,"order")&&(e.order=r.order,!m(e.order))?new TypeError(o("invalid option. `%s` option must be a supported/recognized order. Option: `%s`.","order",e.order)):null:new TypeError(o("invalid argument. Options argument must be an object. Value: `%s`.",r))}function j(e,i,d){var a,m;if((a={}).mode=l,a.order=u,arguments.length>2&&(m=g(a,d)))throw m;if(!r(e))throw new TypeError(o("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!t(i))throw new TypeError(o("invalid argument. Linear index must be integer valued. Value: `%s`.",i));return s(e,n(e,a.order),0,a.order,i,a.mode)}function h(e,s,d,a){var m,p,j;if((m={}).mode=l,m.order=u,4===arguments.length){if(j=g(m,arguments[2]))throw j;if("object"!=typeof a||null===a)throw new TypeError(o("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",a));p=a}else if("object"!=typeof(p=d)||null===p)throw new TypeError(o("invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.",p));if(!r(e))throw new TypeError(o("invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.",e));if(!t(s))throw new TypeError(o("invalid argument. Linear index must be integer valued. Value: `%s`.",s));return i(e,n(e,m.order),0,m.order,s,m.mode,p)}e(j,"assign",h);export{h as assign,j as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..f02adad --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;0jCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,iFAAkF,OAAQP,EAAKI,OAG1HD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,kFAAmF,QAASP,EAAKQ,QAG1H,KAdC,IAAIF,UAAWC,EAAQ,qEAAsEN,GAetG,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,8GAA+GI,IAE7I,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,kGAAmGc,IAEjIC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,kGAAmGe,IAGlI,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,8GAA+GI,IAE7I,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,sEAAuEK,IAGrG,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index f9ee6b2..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 58fdf93..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index ee01d90..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 4413df4..b74c824 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.2.0", - "@stdlib/assert-is-integer": "^0.2.0", - "@stdlib/assert-is-nonnegative-integer-array": "^0.2.0", - "@stdlib/assert-is-plain-object": "^0.2.0", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.2.0", - "@stdlib/ndarray-base-assert-is-order": "^0.2.0", - "@stdlib/ndarray-base-ind2sub": "^0.2.0", - "@stdlib/ndarray-base-shape2strides": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.0", - "@stdlib/types": "^0.3.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.2.0", - "@stdlib/assert-is-array": "^0.2.0", - "@stdlib/math-base-special-floor": "^0.2.0", - "@stdlib/ndarray-base-numel": "^0.2.0", - "@stdlib/random-base-randu": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.0" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -95,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..6a01581 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b505b85..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 6857db979794a4d088b2c501756f853ddf4e35a3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:36:59 +0000 Subject: [PATCH 090/127] Update README.md for ESM bundle v0.2.0 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c0a997e..2f05d68 100644 --- a/README.md +++ b/README.md @@ -52,13 +52,13 @@ limitations under the License. ## Usage ```javascript -import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; +import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@v0.2.0-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@v0.2.0-esm/index.mjs'; ``` #### ind2sub( shape, idx\[, options] ) @@ -153,7 +153,7 @@ The function accepts the same `options` as above. - - - - From d4d3a32d98bc2fb21a3318679e1007b3082acb57 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 21:11:22 +0000 Subject: [PATCH 094/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 266 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 68 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 ---- test/test.js | 40 - test/test.main.js | 752 ---- test/test.validate.js | 160 - 51 files changed, 4873 insertions(+), 6402 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 143618b..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -236,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -301,11 +298,11 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 6f0e1b5..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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-harness' ); -var randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 1e236b2..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 9a12046..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0dcfa02..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..0c5dd82 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.1-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.0-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4312458 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 5e230fc..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 697ffa9..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 2413b4f..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index c40313a..7db95eb 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,46 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-integer": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer-array": "^0.2.1", - "@stdlib/assert-is-plain-object": "^0.2.1", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.2.1", - "@stdlib/ndarray-base-assert-is-order": "^0.2.1", - "@stdlib/ndarray-base-ind2sub": "^0.2.1", - "@stdlib/ndarray-base-shape2strides": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/math-base-special-floor": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/random-base-randu": "^0.2.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -96,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..9c7c69e --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b505b85..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 9e4fed0ae888b5802bf3483576d425c801839c24 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 21:51:27 +0000 Subject: [PATCH 095/127] Update README.md for ESM bundle v0.2.1 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8cd16a6..921c402 100644 --- a/README.md +++ b/README.md @@ -52,13 +52,13 @@ limitations under the License. ## Usage ```javascript -import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; +import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@v0.2.1-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@v0.2.1-esm/index.mjs'; ``` #### ind2sub( shape, idx\[, options] ) @@ -153,7 +153,7 @@ The function accepts the same `options` as above. - - - - From 79545bd346b1425cc70d386257ed96d53ad277ab Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 14:02:38 +0000 Subject: [PATCH 099/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 266 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 68 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 ---- test/test.js | 40 - test/test.main.js | 752 ---- test/test.validate.js | 160 - 52 files changed, 4873 insertions(+), 6404 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index f481a57..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-03-01T06:01:10.889Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 143618b..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -236,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -301,11 +298,11 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 6f0e1b5..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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-harness' ); -var randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 1e236b2..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 9a12046..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0dcfa02..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4bf0337 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.1-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4312458 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 5e230fc..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 697ffa9..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 2413b4f..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index dcd5006..7db95eb 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,46 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-integer": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer-array": "^0.2.1", - "@stdlib/assert-is-plain-object": "^0.2.1", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.2.1", - "@stdlib/ndarray-base-assert-is-order": "^0.2.1", - "@stdlib/ndarray-base-ind2sub": "^0.2.1", - "@stdlib/ndarray-base-shape2strides": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/math-base-special-floor": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/random-base-randu": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -96,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..551ead5 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b505b85..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From b2a7289582722e5dbc02d51cc9bc28ece06d63dd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 07:36:48 +0000 Subject: [PATCH 100/127] Transform error messages --- lib/assign.js | 10 +++++----- lib/main.js | 6 +++--- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index f9ee6b2..5e230fc 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,20 +81,20 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0jx5j', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0jx5j', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len diff --git a/lib/main.js b/lib/main.js index 58fdf93..697ffa9 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,10 +73,10 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index ee01d90..2413b4f 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0jx2V', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0jx5n', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index acca94f..9e1e01e 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.2.1", "@stdlib/ndarray-base-ind2sub": "^0.2.1", "@stdlib/ndarray-base-shape2strides": "^0.2.1", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" From a590d926a009fa026f2df058e36162e35bc5a515 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 13:08:04 +0000 Subject: [PATCH 101/127] Remove files --- index.d.ts | 184 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5031 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 85258d7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -/** -* Interface describing the main export. -*/ -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: ArrayLike ): ArrayLike; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: ArrayLike ): ArrayLike; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4bf0337..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.1-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4312458..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 551ead5..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 6d2498f9a9605927d11ae11f09b95f4ec326fb2f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 13:08:20 +0000 Subject: [PATCH 102/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 266 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 68 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 ---- test/test.js | 40 - test/test.main.js | 752 ---- test/test.validate.js | 160 - 52 files changed, 4873 insertions(+), 6407 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 9ef27b7..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-04-01T05:17:09.093Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 143618b..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index ec90164..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -236,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -301,11 +298,11 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 6f0e1b5..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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-harness' ); -var randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 1e236b2..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 9a12046..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0dcfa02..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4bf0337 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.1-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4312458 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 5e230fc..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 697ffa9..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 2413b4f..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 9e1e01e..7db95eb 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,46 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-integer": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer-array": "^0.2.1", - "@stdlib/assert-is-plain-object": "^0.2.1", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.2.1", - "@stdlib/ndarray-base-assert-is-order": "^0.2.1", - "@stdlib/ndarray-base-ind2sub": "^0.2.1", - "@stdlib/ndarray-base-shape2strides": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/math-base-special-floor": "^0.2.2", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/random-base-randu": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -96,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..551ead5 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b505b85..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 3eca9009ec851651bc11aaa7fff8cb701a3adb21 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 03:51:27 +0000 Subject: [PATCH 103/127] Transform error messages --- lib/assign.js | 10 +++++----- lib/main.js | 6 +++--- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index f9ee6b2..5e230fc 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,20 +81,20 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0jx5j', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0jx5j', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len diff --git a/lib/main.js b/lib/main.js index 58fdf93..697ffa9 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,10 +73,10 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index ee01d90..2413b4f 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0jx2V', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0jx5n', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index acca94f..9e1e01e 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.2.1", "@stdlib/ndarray-base-ind2sub": "^0.2.1", "@stdlib/ndarray-base-shape2strides": "^0.2.1", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" From d99a6066bf96b41ba3f89cfe855b4d6f63ea5c84 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 09:17:30 +0000 Subject: [PATCH 104/127] Remove files --- index.d.ts | 184 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5031 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 85258d7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -/** -* Interface describing the main export. -*/ -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: ArrayLike ): ArrayLike; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: ArrayLike ): ArrayLike; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4bf0337..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.1-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4312458..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 551ead5..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 10d9e472dbfb354d5c5632aa0688fa9302fc9d76 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 09:17:47 +0000 Subject: [PATCH 105/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 134 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 266 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 68 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 ---- test/test.js | 40 - test/test.main.js | 752 ---- test/test.validate.js | 160 - 51 files changed, 4873 insertions(+), 6408 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 143618b..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index ec90164..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -236,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -301,11 +298,11 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 6f0e1b5..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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-harness' ); -var randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 1e236b2..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 9a12046..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0dcfa02..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4bf0337 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.1-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4312458 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 5e230fc..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 697ffa9..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 2413b4f..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 9e1e01e..7db95eb 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,46 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-integer": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer-array": "^0.2.1", - "@stdlib/assert-is-plain-object": "^0.2.1", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.2.1", - "@stdlib/ndarray-base-assert-is-order": "^0.2.1", - "@stdlib/ndarray-base-ind2sub": "^0.2.1", - "@stdlib/ndarray-base-shape2strides": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/math-base-special-floor": "^0.2.2", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/random-base-randu": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -96,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..551ead5 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b505b85..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 0cda8eed57c2d20bbecfdb156371249f6d5f5756 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 03:22:55 +0000 Subject: [PATCH 106/127] Transform error messages --- lib/assign.js | 10 +++++----- lib/main.js | 6 +++--- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index f9ee6b2..5e230fc 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,20 +81,20 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0jx5j', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0jx5j', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len diff --git a/lib/main.js b/lib/main.js index 58fdf93..697ffa9 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,10 +73,10 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index ee01d90..2413b4f 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0jx2V', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0jx5n', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index b0ac708..a3590f4 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.2.2", "@stdlib/ndarray-base-ind2sub": "^0.2.2", "@stdlib/ndarray-base-shape2strides": "^0.2.2", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.3.2", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" From 370964dcc3680d642483a8ebe85dac1e0d744869 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 03:44:58 +0000 Subject: [PATCH 107/127] Remove files --- index.d.ts | 184 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5031 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 85258d7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -/** -* Interface describing the main export. -*/ -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: ArrayLike ): ArrayLike; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: ArrayLike ): ArrayLike; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4bf0337..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.1-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4312458..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 551ead5..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 40b722a10a1ddf676e9ac493ce949e809b6cfb16 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 03:45:21 +0000 Subject: [PATCH 108/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 220 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 266 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 68 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 ---- test/test.js | 40 - test/test.main.js | 752 ---- test/test.validate.js | 160 - 51 files changed, 4873 insertions(+), 6636 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 143618b..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -236,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -301,11 +298,11 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 6f0e1b5..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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-harness' ); -var randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 1e236b2..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 9a12046..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0dcfa02..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..79a7dde --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.2-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.2-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.2-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.1-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4312458 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 5e230fc..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 697ffa9..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 2413b4f..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index a3590f4..795bac8 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,46 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-integer": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer-array": "^0.2.2", - "@stdlib/assert-is-plain-object": "^0.2.2", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.2.1", - "@stdlib/ndarray-base-assert-is-order": "^0.2.2", - "@stdlib/ndarray-base-ind2sub": "^0.2.2", - "@stdlib/ndarray-base-shape2strides": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/random-base-randu": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -96,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..2c9383e --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b505b85..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 9ea9b3ba3bc4aaf37e419c3ea733fd1397d787cf Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 03:51:37 +0000 Subject: [PATCH 109/127] Update README.md for ESM bundle v0.2.2 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e407a34..1bf8531 100644 --- a/README.md +++ b/README.md @@ -52,13 +52,13 @@ limitations under the License. ## Usage ```javascript -import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; +import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@v0.2.2-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@v0.2.2-esm/index.mjs'; ``` #### ind2sub( shape, idx\[, options] ) @@ -153,7 +153,7 @@ The function accepts the same `options` as above. - - - - From b76f835f0e1f19f7829bd310dbb8ce2f85e51e4d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 13:22:37 +0000 Subject: [PATCH 113/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 158 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 266 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 68 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 ---- test/test.js | 40 - test/test.main.js | 752 ---- test/test.validate.js | 160 - 52 files changed, 4873 insertions(+), 6575 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index f3cc35a..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-08-01T06:11:02.344Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 143618b..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -236,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -301,11 +298,11 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 6f0e1b5..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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-harness' ); -var randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 1e236b2..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 9a12046..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0dcfa02..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..0e047f7 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.2-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.2-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.2-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.2-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4312458 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 5e230fc..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 697ffa9..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 2413b4f..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 8366acf..795bac8 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,46 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-integer": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer-array": "^0.2.2", - "@stdlib/assert-is-plain-object": "^0.2.2", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.2.2", - "@stdlib/ndarray-base-assert-is-order": "^0.2.2", - "@stdlib/ndarray-base-ind2sub": "^0.2.2", - "@stdlib/ndarray-base-shape2strides": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/random-base-randu": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -96,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3854840 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b505b85..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From d094253ca0e1a4e92849dad5389ef80c813d7013 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 28 Sep 2024 21:25:35 +0000 Subject: [PATCH 114/127] Transform error messages --- lib/assign.js | 10 +++++----- lib/main.js | 6 +++--- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index f9ee6b2..5e230fc 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,20 +81,20 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0jx5j', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0jx5j', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len diff --git a/lib/main.js b/lib/main.js index 58fdf93..697ffa9 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,10 +73,10 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index ee01d90..2413b4f 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0jx2V', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0jx5n', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 89a3de0..4e5c14d 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.2.2", "@stdlib/ndarray-base-ind2sub": "^0.2.2", "@stdlib/ndarray-base-shape2strides": "^0.2.2", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.1", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" From 56c366d32fb751d7664384db2e0bf545c714cf75 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 28 Sep 2024 21:33:43 +0000 Subject: [PATCH 115/127] Remove files --- index.d.ts | 184 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5031 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 85258d7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -/** -* Interface describing the main export. -*/ -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: ArrayLike ): ArrayLike; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: ArrayLike ): ArrayLike; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0e047f7..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.2-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.2-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.2-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.2-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4312458..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3854840..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 4f37bbb738ead0e05119b256741684981d733242 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 28 Sep 2024 21:33:58 +0000 Subject: [PATCH 116/127] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 253 -- CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 266 -- benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 68 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 ---- test/test.js | 40 - test/test.main.js | 752 ---- test/test.validate.js | 160 - 51 files changed, 4873 insertions(+), 6669 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9ff1a47..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 143618b..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -236,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -301,11 +298,11 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 6f0e1b5..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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-harness' ); -var randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 1e236b2..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 9a12046..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 01bf62b..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true, opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..0e047f7 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.2-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.2-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.2-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.2-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4312458 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 5e230fc..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 697ffa9..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 2413b4f..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 4e5c14d..795bac8 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,46 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-integer": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer-array": "^0.2.2", - "@stdlib/assert-is-plain-object": "^0.2.2", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.2.2", - "@stdlib/ndarray-base-assert-is-order": "^0.2.2", - "@stdlib/ndarray-base-ind2sub": "^0.2.2", - "@stdlib/ndarray-base-shape2strides": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/random-base-randu": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -96,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3854840 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b505b85..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From d4aa92e848339def931fbaba0c50d8cf4184947d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 17 Mar 2025 01:38:35 +0000 Subject: [PATCH 117/127] Transform error messages --- lib/assign.js | 10 +++++----- lib/main.js | 6 +++--- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index f9ee6b2..5e230fc 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,20 +81,20 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0jx5j', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0jx5j', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len diff --git a/lib/main.js b/lib/main.js index 58fdf93..697ffa9 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,10 +73,10 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index ee01d90..2413b4f 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0jx2V', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0jx5n', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 92f21b8..2e84a61 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.2.2", "@stdlib/ndarray-base-ind2sub": "^0.2.2", "@stdlib/ndarray-base-shape2strides": "^0.2.2", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" From 7767c1cf41d44b01bcba0a868682f2d618815a42 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 17 Mar 2025 02:35:08 +0000 Subject: [PATCH 118/127] Remove files --- index.d.ts | 184 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5031 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 85258d7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -/** -* Interface describing the main export. -*/ -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: ArrayLike ): ArrayLike; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: ArrayLike ): ArrayLike; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 0e047f7..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.2-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.2-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.2-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.2-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4312458..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3854840..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 4f9296da9616ed57bca25ae5df78ea6cba16692a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 17 Mar 2025 02:35:38 +0000 Subject: [PATCH 119/127] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 253 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 266 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 ---- test/test.js | 40 - test/test.main.js | 752 --- test/test.validate.js | 160 - 53 files changed, 4873 insertions(+), 6778 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index da96707..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-03-17T01:28:15.413Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 74697bd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 143618b..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -236,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -301,11 +298,11 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 6f0e1b5..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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-harness' ); -var randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 1e236b2..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 9a12046..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"mode\": \"throw\",\n\t\"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACC,KAAQ,QACR,MAAS,WACV,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 01bf62b..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true, opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..cac2d19 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.2-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.2-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.2-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.2-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4312458 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 5e230fc..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 8920fad..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 697ffa9..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 2413b4f..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 2e84a61..795bac8 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,46 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-integer": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer-array": "^0.2.2", - "@stdlib/assert-is-plain-object": "^0.2.2", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.2.2", - "@stdlib/ndarray-base-assert-is-order": "^0.2.2", - "@stdlib/ndarray-base-ind2sub": "^0.2.2", - "@stdlib/ndarray-base-shape2strides": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/random-base-randu": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -96,7 +33,6 @@ "idx", "strided" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3854840 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index b505b85..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns an array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9659809..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 47e22fcf2cfb2187ece7ce09298aacb22c0feccc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 01:59:50 +0000 Subject: [PATCH 120/127] Transform error messages --- lib/assign.js | 10 +++++----- lib/main.js | 6 +++--- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index f9ee6b2..5e230fc 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,20 +81,20 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0jx5j', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0jx5j', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len diff --git a/lib/main.js b/lib/main.js index 58fdf93..697ffa9 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,10 +73,10 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index ee01d90..2413b4f 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0jx2V', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0jx5n', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 5fa5e04..13efe0c 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.2.2", "@stdlib/ndarray-base-ind2sub": "^0.2.2", "@stdlib/ndarray-base-shape2strides": "^0.2.2", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" From 6fc7e5b394969217c81cdc19be0ad289fd53b045 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 03:12:43 +0000 Subject: [PATCH 121/127] Remove files --- index.d.ts | 184 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5031 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 85258d7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -/** -* Interface describing the main export. -*/ -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: ArrayLike ): ArrayLike; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: ArrayLike ): ArrayLike; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index cac2d19..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.2-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.2-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.2-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.2-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4312458..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3854840..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 6c007c6da143b69ea1e6ef3ce5ddcaf993d22ab3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 03:13:06 +0000 Subject: [PATCH 122/127] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 108 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 256 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 266 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 ---- test/test.js | 40 - test/test.main.js | 752 --- test/test.validate.js | 160 - 52 files changed, 4873 insertions(+), 6884 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 74697bd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 143618b..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -236,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -301,11 +298,11 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 6f0e1b5..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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-harness' ); -var randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 1e236b2..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 70c1453..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n \"mode\": \"throw\",\n \"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACE,KAAQ,QACR,MAAS,WACX,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 01bf62b..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true, opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3c945c1 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.2-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.2-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.2-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.2-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4312458 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 5e230fc..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 59a64b3..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 697ffa9..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 2413b4f..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 13efe0c..795bac8 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,46 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-integer": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer-array": "^0.2.2", - "@stdlib/assert-is-plain-object": "^0.2.2", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.2.2", - "@stdlib/ndarray-base-assert-is-order": "^0.2.2", - "@stdlib/ndarray-base-ind2sub": "^0.2.2", - "@stdlib/ndarray-base-shape2strides": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/random-base-randu": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3854840 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 85dac67..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index a7313a1..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns expected value' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns expected value' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 607856bc49080b6b57ded2930ac7595831d3f55a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 18:20:08 +0000 Subject: [PATCH 123/127] Transform error messages --- lib/assign.js | 10 +++++----- lib/main.js | 6 +++--- lib/validate.js | 8 ++++---- package.json | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/lib/assign.js b/lib/assign.js index f9ee6b2..5e230fc 100644 --- a/lib/assign.js +++ b/lib/assign.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -81,20 +81,20 @@ function ind2sub( shape, idx, options, out ) { throw err; } if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) ); + throw new TypeError( format( '0jx5j', out ) ); } dest = out; } else { dest = options; if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) ); + throw new TypeError( format( '0jx5j', dest ) ); } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len diff --git a/lib/main.js b/lib/main.js index 58fdf93..697ffa9 100644 --- a/lib/main.js +++ b/lib/main.js @@ -24,7 +24,7 @@ var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer- var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -73,10 +73,10 @@ function ind2sub( shape, idx, options ) { } } if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) ); + throw new TypeError( format( '0jx5k', shape ) ); } if ( !isInteger( idx ) ) { - throw new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) ); + throw new TypeError( format( '0jx5l', idx ) ); } // Note: strides are positive, so offset is always zero return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index ee01d90..2413b4f 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -24,7 +24,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -52,18 +52,18 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '0jx2V', options ) ); } if ( hasOwnProp( options, 'mode' ) ) { opts.mode = options.mode; if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) ); + return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); } } if ( hasOwnProp( options, 'order' ) ) { opts.order = options.order; if ( !isOrder( opts.order ) ) { - return new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) ); + return new TypeError( format( '0jx5n', 'order', opts.order ) ); } } return null; diff --git a/package.json b/package.json index 1cf74ee..75cb997 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@stdlib/ndarray-base-assert-is-order": "^0.2.2", "@stdlib/ndarray-base-ind2sub": "^0.2.3", "@stdlib/ndarray-base-shape2strides": "^0.2.3", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.4.3", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" From 4846fcd1c7fefdc7364b9fb4a55d83b7e0fd2c27 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 19:17:15 +0000 Subject: [PATCH 124/127] Remove files --- index.d.ts | 184 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5031 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 85258d7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,184 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 - -/// -/// - -import { ArrayLike } from '@stdlib/types/array'; -import { Mode, Order } from '@stdlib/types/ndarray'; - -/** -* Interface defining function options. -*/ -interface Options { - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major'). - */ - order?: Order; -} - -/** -* Interface describing the main export. -*/ -interface Ind2Sub { - /** - * Converts a linear index to an array of subscripts. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var s = ind2sub( [ 3, 3, 3 ], 17 ); - * // returns [ 1, 2, 2 ] - */ - ( shape: ArrayLike, idx: number, options?: Options ): Array; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param options - function options - * @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') - * @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide valid options - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, options: Options, out: ArrayLike ): ArrayLike; - - /** - * Converts a linear index to an array of subscripts and assigns results to a provided output array. - * - * ## Notes - * - * - The function accepts the following "modes": - * - * - **throw**: throw an error when a linear index exceeds array dimensions. - * - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. - * - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. - * - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. - * - * @param shape - array shape - * @param idx - linear index - * @param out - output array - * @throws output argument must be either an array, typed array, or an object - * @throws shape argument must be an array-like object containing nonnegative integers - * @throws must provide a linear index which does not exceed array dimensions - * @returns subscripts - * - * @example - * var shape = [ 3, 3, 3 ]; - * var out = [ 0, 0, 0 ]; - * - * var s = ind2sub.assign( shape, 17, out ); - * // returns [ 1, 2, 2 ] - * - * var bool = ( s === out ); - * // returns true - */ - assign( shape: ArrayLike, idx: number, out: ArrayLike ): ArrayLike; -} - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param shape - array shape -* @param idx - linear index -* @param options - function options -* @param options.mode - specifies how to handle a linear index which exceeds array dimensions (default: 'throw') -* @param options.order - specifies whether an array is row-major (C-style) or column-major (Fortran-style) (default: 'row-major') -* @throws shape argument must be an array-like object containing nonnegative integers -* @throws must provide valid options -* @throws must provide a linear index which does not exceed array dimensions -* @returns subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -declare var ind2sub: Ind2Sub; - - -// EXPORTS // - -export = ind2sub; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 3c945c1..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.2-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.2-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.2-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.2-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4312458..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3854840..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 2fed867ccfd5cde50c83b00785ec835bedca294b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 19:17:34 +0000 Subject: [PATCH 125/127] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 256 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 266 - benchmark/julia/REQUIRE | 2 - benchmark/julia/benchmark.jl | 144 - benchmark/python/numpy/benchmark.py | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 92 - docs/types/test.ts | 213 - examples/index.js | 58 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 106 - lib/defaults.json | 4 - lib/index.js | 59 - lib/main.js | 88 - lib/validate.js | 75 - package.json | 67 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 879 ---- test/test.js | 40 - test/test.main.js | 752 --- test/test.validate.js | 160 - 52 files changed, 4873 insertions(+), 6877 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/julia/REQUIRE delete mode 100644 benchmark/julia/benchmark.jl delete mode 100644 benchmark/python/numpy/benchmark.py delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/defaults.json delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 74697bd..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 37af1d5..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 143618b..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '19 19 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -236,7 +233,7 @@ for ( i = 0; i < len; i++ ) { ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. @@ -301,11 +298,11 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. -[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array +[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray-array/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind +[@stdlib/ndarray/sub2ind]: https://github.com/stdlib-js/ndarray-sub2ind/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 6f0e1b5..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,266 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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-harness' ); -var randu = require( '@stdlib/random-base-randu' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var ind2sub = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::memory_reuse:assign', function benchmark( b ) { - var shape; - var len; - var out; - var idx; - var s; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - out = [ 0, 0, 0 ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - s = ind2sub.assign( shape, idx, out ); - if ( s !== out ) { - b.fail( 'should return output array' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( s ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=wrap', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'wrap' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=clamp', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'clamp' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=normalize', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'normalize' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len*2.0 ) - len; - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':mode=throw', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'mode': 'throw' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=row-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'row-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':order=column-major', function benchmark( b ) { - var shape; - var opts; - var len; - var out; - var idx; - var i; - - shape = [ 10, 10, 10 ]; - len = numel( shape ); - opts = { - 'order': 'column-major' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - idx = floor( randu()*len ); - out = ind2sub( shape, idx, opts ); - if ( out.length !== shape.length ) { - b.fail( 'should return an array with expected length' ); - } - } - b.toc(); - if ( !isNonNegativeIntegerArray( out ) ) { - b.fail( 'should return an array containing nonnegative integers' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/julia/REQUIRE b/benchmark/julia/REQUIRE deleted file mode 100644 index 98645e1..0000000 --- a/benchmark/julia/REQUIRE +++ /dev/null @@ -1,2 +0,0 @@ -julia 1.5 -BenchmarkTools 0.5.0 diff --git a/benchmark/julia/benchmark.jl b/benchmark/julia/benchmark.jl deleted file mode 100644 index f9805fc..0000000 --- a/benchmark/julia/benchmark.jl +++ /dev/null @@ -1,144 +0,0 @@ -#!/usr/bin/env julia -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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 BenchmarkTools -using Printf - -# Benchmark variables: -name = "ind2sub"; -repeats = 3; - -""" - print_version() - -Prints the TAP version. - -# Examples - -``` julia -julia> print_version() -``` -""" -function print_version() - @printf( "TAP version 13\n" ); -end - -""" - print_summary( total, passing ) - -Print the benchmark summary. - -# Arguments - -* `total`: total number of tests -* `passing`: number of passing tests - -# Examples - -``` julia -julia> print_summary( 3, 3 ) -``` -""" -function print_summary( total, passing ) - @printf( "#\n" ); - @printf( "1..%d\n", total ); # TAP plan - @printf( "# total %d\n", total ); - @printf( "# pass %d\n", passing ); - @printf( "#\n" ); - @printf( "# ok\n" ); -end - -""" - print_results( iterations, elapsed ) - -Print benchmark results. - -# Arguments - -* `iterations`: number of iterations -* `elapsed`: elapsed time (in seconds) - -# Examples - -``` julia -julia> print_results( 1000000, 0.131009101868 ) -``` -""" -function print_results( iterations, elapsed ) - rate = iterations / elapsed - - @printf( " ---\n" ); - @printf( " iterations: %d\n", iterations ); - @printf( " elapsed: %0.9f\n", elapsed ); - @printf( " rate: %0.9f\n", rate ); - @printf( " ...\n" ); -end - -""" - benchmark() - -Run a benchmark. - -# Notes - -* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. -* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. -* The elapsed time is in seconds. - -# Examples - -``` julia -julia> out = benchmark(); -``` -""" -function benchmark() - t = BenchmarkTools.@benchmark Base._ind2sub( (10,10,10), Int32( floor( rand()*1000.0 ) ) ) samples=1e6 - - # Compute the total "elapsed" time and convert from nanoseconds to seconds: - s = sum( t.times ) / 1.0e9; - - # Determine the number of "iterations": - iter = length( t.times ); - - # Return the results: - [ iter, s ]; -end - -""" - main() - -Run benchmarks. - -# Examples - -``` julia -julia> main(); -``` -""" -function main() - print_version(); - for i in 1:repeats - @printf( "# julia::%s\n", name ); - results = benchmark(); - print_results( results[ 1 ], results[ 2 ] ); - @printf( "ok %d benchmark finished\n", i ); - end - print_summary( repeats, repeats ); -end - -main(); diff --git a/benchmark/python/numpy/benchmark.py b/benchmark/python/numpy/benchmark.py deleted file mode 100644 index 8dbf819..0000000 --- a/benchmark/python/numpy/benchmark.py +++ /dev/null @@ -1,97 +0,0 @@ -#!/usr/bin/env python -# -# @license Apache-2.0 -# -# Copyright (c) 2018 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. - -"""Benchmark numpy.unravel_index.""" - -from __future__ import print_function -import timeit - -NAME = "ind2sub" -REPEATS = 3 -ITERATIONS = 1000000 - - -def print_version(): - """Print the TAP version.""" - print("TAP version 13") - - -def print_summary(total, passing): - """Print the benchmark summary. - - # Arguments - - * `total`: total number of tests - * `passing`: number of passing tests - - """ - print("#") - print("1.." + str(total)) # TAP plan - print("# total " + str(total)) - print("# pass " + str(passing)) - print("#") - print("# ok") - - -def print_results(elapsed): - """Print benchmark results. - - # Arguments - - * `elapsed`: elapsed time (in seconds) - - # Examples - - ``` python - python> print_results(0.131009101868) - ``` - """ - rate = ITERATIONS / elapsed - - print(" ---") - print(" iterations: " + str(ITERATIONS)) - print(" elapsed: " + str(elapsed)) - print(" rate: " + str(rate)) - print(" ...") - - -def benchmark(): - """Run the benchmark and print benchmark results.""" - setup = "import numpy as np; from random import random;" - stmt = "y = np.unravel_index(int(random()*1000.0), (10,10,10))" - - t = timeit.Timer(stmt, setup=setup) - - print_version() - - for i in range(REPEATS): - print("# python::numpy::" + NAME) - elapsed = t.timeit(number=ITERATIONS) - print_results(elapsed) - print("ok " + str(i+1) + " benchmark finished") - - print_summary(REPEATS, REPEATS) - - -def main(): - """Run the benchmark.""" - benchmark() - - -if __name__ == "__main__": - main() diff --git a/branches.md b/branches.md deleted file mode 100644 index 1e236b2..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub" -%% click B href "https://github.com/stdlib-js/ndarray-ind2sub/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-ind2sub/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-ind2sub/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-ind2sub/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-ind2sub/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ind2sub -[production-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-ind2sub/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-ind2sub/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 6e24bd3..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ind2sub from '../docs/types/index'; -export = ind2sub; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 3594eab..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=n(function(G,j){j.exports={mode:"throw",order:"row-major"}});var m=n(function(H,l){ -var E=require('@stdlib/assert-is-plain-object/dist'),g=require('@stdlib/assert-has-own-property/dist'),O=require('@stdlib/ndarray-base-assert-is-order/dist'),T=require('@stdlib/ndarray-base-assert-is-index-mode/dist'),v=require('@stdlib/error-tools-fmtprodmsg/dist');function V(e,r){return E(r)?g(r,"mode")&&(e.mode=r.mode,!T(e.mode))?new TypeError(v('0jx5m',"mode",e.mode)):g(r,"order")&&(e.order=r.order,!O(e.order))?new TypeError(v('0jx5n',"order",e.order)):null:new TypeError(v('0jx2V',r));}l.exports=V -});var y=n(function(J,q){ -var I=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,N=require('@stdlib/assert-is-integer/dist').isPrimitive,S=require('@stdlib/ndarray-base-shape2strides/dist'),x=require('@stdlib/ndarray-base-ind2sub/dist'),f=require('@stdlib/error-tools-fmtprodmsg/dist'),p=d(),P=m();function k(e,r,o){var i,t;if(i={},i.mode=p.mode,i.order=p.order,arguments.length>2&&(t=P(i,o),t))throw t;if(!I(e))throw new TypeError(f('0jx5k',e));if(!N(r))throw new TypeError(f('0jx5l',r));return x(e,S(e,i.order),0,i.order,r,i.mode)}q.exports=k -});var w=n(function(K,c){ -var z=require('@stdlib/assert-is-nonnegative-integer-array/dist').primitives,A=require('@stdlib/assert-is-integer/dist').isPrimitive,L=require('@stdlib/ndarray-base-shape2strides/dist'),M=require('@stdlib/ndarray-base-ind2sub/dist').assign,u=require('@stdlib/error-tools-fmtprodmsg/dist'),b=d(),R=m();function B(e,r,o,i){var t,a,s;if(t={},t.mode=b.mode,t.order=b.order,arguments.length===4){if(s=R(t,arguments[2]),s)throw s;if(typeof i!="object"||i===null)throw new TypeError(u('0jx5j',i));a=i}else if(a=o,typeof a!="object"||a===null)throw new TypeError(u('0jx5j',a));if(!z(e))throw new TypeError(u('0jx5k',e));if(!A(r))throw new TypeError(u('0jx5l',r));return M(e,L(e,t.order),0,t.order,r,t.mode,a)}c.exports=B -});var C=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=y(),D=w();C(h,"assign",D);module.exports=h; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index 70c1453..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/main.js", "../lib/assign.js", "../lib/index.js"], - "sourcesContent": ["{\n \"mode\": \"throw\",\n \"order\": \"row-major\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isOrder = require( '@stdlib/ndarray-base-assert-is-order' );\nvar isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized mode. Option: `%s`.', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a supported/recognized order. Option: `%s`.', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives;\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar shape2strides = require( '@stdlib/ndarray-base-shape2strides' );\nvar getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign;\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Output argument must be either an array, typed array, or object. Value: `%s`.', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Shape argument must be an array-like object containing nonnegative integers. Value: `%s`.', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Linear index must be integer valued. Value: `%s`.', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nmodule.exports = ind2sub;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* var ind2sub = require( '@stdlib/ndarray-ind2sub' );\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,CAAAA,EAAA,SACE,KAAQ,QACR,MAAS,WACX,ICHA,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAU,QAAS,sCAAuC,EAC1DC,EAAc,QAAS,2CAA4C,EACnEC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,MAAO,IAChCD,EAAK,KAAOC,EAAQ,KACf,CAACJ,EAAaG,EAAK,IAAK,GACrB,IAAI,UAAWF,EAAQ,iFAAkF,OAAQE,EAAK,IAAK,CAAE,EAGjIL,EAAYM,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChB,CAACL,EAASI,EAAK,KAAM,GAClB,IAAI,UAAWF,EAAQ,kFAAmF,QAASE,EAAK,KAAM,CAAE,EAGlI,KAdC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAehH,CAKAR,EAAO,QAAUM,IC1EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EACxDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAiCf,SAASC,EAASC,EAAOC,EAAKC,EAAU,CACvC,IAAIC,EACAC,EAKJ,GAHAD,EAAO,CAAC,EACRA,EAAK,KAAON,EAAS,KACrBM,EAAK,MAAQN,EAAS,MACjB,UAAU,OAAS,IACvBO,EAAMN,EAAUK,EAAMD,CAAQ,EACzBE,GACJ,MAAMA,EAGR,GAAK,CAACZ,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOG,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOF,EAAKE,EAAK,IAAK,CAChG,CAKAZ,EAAO,QAAUQ,ICvFjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAA4B,QAAS,6CAA8C,EAAE,WACrFC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAgB,QAAS,8BAA+B,EAAE,OAC1DC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAyCf,SAASC,EAASC,EAAOC,EAAKC,EAASC,EAAM,CAC5C,IAAIC,EACAC,EACAC,EAKJ,GAHAF,EAAO,CAAC,EACRA,EAAK,KAAOP,EAAS,KACrBO,EAAK,MAAQP,EAAS,MACjB,UAAU,SAAW,EAAI,CAE7B,GADAS,EAAMR,EAAUM,EAAM,UAAW,CAAE,CAAE,EAChCE,EACJ,MAAMA,EAEP,GAAK,OAAOH,GAAQ,UAAYA,IAAQ,KACvC,MAAM,IAAI,UAAWP,EAAQ,kGAAmGO,CAAI,CAAE,EAEvIE,EAAOF,CACR,SACCE,EAAOH,EACF,OAAOG,GAAS,UAAYA,IAAS,KACzC,MAAM,IAAI,UAAWT,EAAQ,kGAAmGS,CAAK,CAAE,EAGzI,GAAK,CAACb,EAA2BQ,CAAM,EACtC,MAAM,IAAI,UAAWJ,EAAQ,8GAA+GI,CAAM,CAAE,EAErJ,GAAK,CAACP,EAAWQ,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,sEAAuEK,CAAI,CAAE,EAG3G,OAAON,EAAeK,EAAON,EAAeM,EAAOI,EAAK,KAAM,EAAG,EAAGA,EAAK,MAAOH,EAAKG,EAAK,KAAMC,CAAK,CACtG,CAKAd,EAAO,QAAUQ,IC3DjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "isOrder", "isIndexMode", "format", "validate", "opts", "options", "require_main", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "opts", "err", "require_assign", "__commonJSMin", "exports", "module", "isNonNegativeIntegerArray", "isInteger", "shape2strides", "getSubscripts", "format", "defaults", "validate", "ind2sub", "shape", "idx", "options", "out", "opts", "dest", "err", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 9e1dd1a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,92 +0,0 @@ - -{{alias}}( shape, idx[, options] ) - Converts a linear index to an array of subscripts. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - Returns - ------- - out: Array - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var s = {{alias}}( d, 17 ) - [ 1, 2, 2 ] - - -{{alias}}.assign( shape, idx[, options], out ) - Converts a linear index to an array of subscripts and assigns results to a - provided output array. - - Parameters - ---------- - shape: ArrayLike - Array shape. - - idx: integer - Linear index. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle a linear index which exceeds array dimensions. - If equal to 'throw', the function throws an error when a linear index - exceeds array dimensions. If equal to 'normalize', the function - normalizes negative linear indices and throws an error when a linear - index exceeds array dimensions. If equal to 'wrap', the function wraps - around a linear index exceeding array dimensions using modulo - arithmetic. If equal to 'clamp', the function sets a linear index - exceeding array dimensions to either `0` (minimum linear index) or the - maximum linear index. Default: 'throw'. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Subscripts. - - Examples - -------- - > var d = [ 3, 3, 3 ]; - > var out = [ 0, 0, 0 ]; - > var s = {{alias}}.assign( d, 17, out ) - [ 1, 2, 2 ] - > var bool = ( s === out ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 01bf62b..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,213 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2021 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 ind2sub = require( './index' ); - - -// TESTS // - -// The function returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'throw' } ); // $ExpectType number[] - ind2sub( shape, idx, { 'order': 'row-major' } ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - ind2sub( true, idx ); // $ExpectError - ind2sub( false, idx ); // $ExpectError - ind2sub( null, idx ); // $ExpectError - ind2sub( undefined, idx ); // $ExpectError - ind2sub( '5', idx ); // $ExpectError - ind2sub( [ '1', '2' ], idx ); // $ExpectError - ind2sub( {}, idx ); // $ExpectError - ind2sub( ( x: number ): number => x, idx ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - ind2sub( shape, 'abc' ); // $ExpectError - ind2sub( shape, true ); // $ExpectError - ind2sub( shape, false ); // $ExpectError - ind2sub( shape, null ); // $ExpectError - ind2sub( shape, undefined ); // $ExpectError - ind2sub( shape, [] ); // $ExpectError - ind2sub( shape, {} ); // $ExpectError - ind2sub( shape, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, 'abc' ); // $ExpectError - ind2sub( shape, idx, 123 ); // $ExpectError - ind2sub( shape, idx, true ); // $ExpectError - ind2sub( shape, idx, false ); // $ExpectError - ind2sub( shape, idx, null ); // $ExpectError - ind2sub( shape, idx, [] ); // $ExpectError - ind2sub( shape, idx, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'order': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'order': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'order': true } ); // $ExpectError - ind2sub( shape, idx, { 'order': false } ); // $ExpectError - ind2sub( shape, idx, { 'order': null } ); // $ExpectError - ind2sub( shape, idx, { 'order': [] } ); // $ExpectError - ind2sub( shape, idx, { 'order': {} } ); // $ExpectError - ind2sub( shape, idx, { 'order': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub( shape, idx, { 'mode': 'abc' } ); // $ExpectError - ind2sub( shape, idx, { 'mode': 123 } ); // $ExpectError - ind2sub( shape, idx, { 'mode': true } ); // $ExpectError - ind2sub( shape, idx, { 'mode': false } ); // $ExpectError - ind2sub( shape, idx, { 'mode': null } ); // $ExpectError - ind2sub( shape, idx, { 'mode': [] } ); // $ExpectError - ind2sub( shape, idx, { 'mode': {} } ); // $ExpectError - ind2sub( shape, idx, { 'mode': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an invalid number of arguments... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - ind2sub(); // $ExpectError - ind2sub( shape ); // $ExpectError - ind2sub( shape, idx, {}, {} ); // $ExpectError -} - -// Attached to main export is a `assign` method which returns an array of numbers... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, 0, out ); // $ExpectType ArrayLike - ind2sub.assign( shape, 0, { 'mode': 'throw' }, out ); // $ExpectType ArrayLike -} - -// The `assign` method does not compile if provided a first argument which is not an array-like object containing numbers... -{ - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( 123, idx, out ); // $ExpectError - ind2sub.assign( true, idx, out ); // $ExpectError - ind2sub.assign( false, idx, out ); // $ExpectError - ind2sub.assign( null, idx, out ); // $ExpectError - ind2sub.assign( undefined, idx, out ); // $ExpectError - ind2sub.assign( '5', idx, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, out ); // $ExpectError - ind2sub.assign( {}, idx, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( 123, idx, opts, out ); // $ExpectError - ind2sub.assign( true, idx, opts, out ); // $ExpectError - ind2sub.assign( false, idx, opts, out ); // $ExpectError - ind2sub.assign( null, idx, opts, out ); // $ExpectError - ind2sub.assign( undefined, idx, opts, out ); // $ExpectError - ind2sub.assign( '5', idx, opts, out ); // $ExpectError - ind2sub.assign( [ '1', '2' ], idx, opts, out ); // $ExpectError - ind2sub.assign( {}, idx, opts, out ); // $ExpectError - ind2sub.assign( ( x: number ): number => x, idx, opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided a second argument which is not a number... -{ - const shape = [ 3, 3, 3 ]; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, true, out ); // $ExpectError - ind2sub.assign( shape, false, out ); // $ExpectError - ind2sub.assign( shape, null, out ); // $ExpectError - ind2sub.assign( shape, undefined, out ); // $ExpectError - ind2sub.assign( shape, 'abc', out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ], out ); // $ExpectError - ind2sub.assign( shape, {}, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x, out ); // $ExpectError - - const opts = { - 'order': 'row-major' - }; - ind2sub.assign( shape, true, opts, out ); // $ExpectError - ind2sub.assign( shape, false opts, out ); // $ExpectError - ind2sub.assign( shape, null opts, out ); // $ExpectError - ind2sub.assign( shape, undefined opts, out ); // $ExpectError - ind2sub.assign( shape, 'abc' opts, out ); // $ExpectError - ind2sub.assign( shape, [ '1', '2' ] opts, out ); // $ExpectError - ind2sub.assign( shape, {} opts, out ); // $ExpectError - ind2sub.assign( shape, ( x: number ): number => x opts, out ); // $ExpectError -} - -// The `assign` method does not compile if provided an options argument which is not an options object... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, 'abc', out ); // $ExpectError - ind2sub.assign( shape, idx, 123, out ); // $ExpectError - ind2sub.assign( shape, idx, true, out ); // $ExpectError - ind2sub.assign( shape, idx, false, out ); // $ExpectError - ind2sub.assign( shape, idx, null, out ); // $ExpectError - ind2sub.assign( shape, idx, undefined, out ); // $ExpectError - ind2sub.assign( shape, idx, [], out ); // $ExpectError - ind2sub.assign( shape, idx, ( x: number ): number => x, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an `order` option which is not a recognized order... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'order': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'order': ( x: number ): number => x }, out ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a `mode` option which is not a recognized mode... -{ - const shape = [ 3, 3, 3 ]; - const idx = 17; - const out = [ 0, 0, 0 ]; - ind2sub.assign( shape, idx, { 'mode': 'abc' }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': 123 }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': true }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': false }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': null }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': [] }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': {} }, out ); // $ExpectError - ind2sub.assign( shape, idx, { 'mode': ( x: number ): number => x }, out ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 103914a..0000000 --- a/examples/index.js +++ /dev/null @@ -1,58 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray-base-numel' ); -var ind2sub = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; -var len = numel( shape ); - -var arr = []; -var i; -for ( i = 0; i < len; i++ ) { - arr.push( i ); -} - -var opts = { - 'order': 'column-major' -}; - -console.log( '' ); -console.log( 'Dimensions: %s.', shape.join( 'x' ) ); -console.log( 'View (subscripts):' ); -console.log( '' ); - -var row; -var s; - -row = ' '; -for ( i = 0; i < len; i++ ) { - s = ind2sub( shape, i, opts ); - row += '(' + s.join( ',' ) + ')'; - if ( (i+1)%shape[0] === 0 ) { - console.log( row ); - row = ' '; - } else { - row += ', '; - } - if ( (i+1)%(shape[0]*shape[1]) === 0 ) { - console.log( '' ); - } -} diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 639b55c..85258d7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// /// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c85fa8 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{primitives as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer-array@v0.2.3-esm/index.mjs";import{isPrimitive as s}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-integer@v0.2.3-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.3-esm/index.mjs";import o,{assign as d}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-ind2sub@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-order@v0.2.2-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-assert-is-index-mode@v0.2.2-esm/index.mjs";var l="throw",a="row-major";function h(r,e){return i(e)?m(e,"mode")&&(r.mode=e.mode,!p(r.mode))?new TypeError(n("0jx5m","mode",r.mode)):m(e,"order")&&(r.order=e.order,!j(r.order))?new TypeError(n("0jx5n","order",r.order)):null:new TypeError(n("0jx2V",e))}function f(r,d,i){var m,j;if((m={}).mode=l,m.order=a,arguments.length>2&&(j=h(m,i)))throw j;if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(d))throw new TypeError(n("0jx5l",d));return o(r,t(r,m.order),0,m.order,d,m.mode)}function v(r,o,i,m){var j,p,f;if((j={}).mode=l,j.order=a,4===arguments.length){if(f=h(j,arguments[2]))throw f;if("object"!=typeof m||null===m)throw new TypeError(n("0jx5j",m));p=m}else if("object"!=typeof(p=i)||null===p)throw new TypeError(n("0jx5j",p));if(!e(r))throw new TypeError(n("0jx5k",r));if(!s(o))throw new TypeError(n("0jx5l",o));return d(r,t(r,j.order),0,j.order,o,j.mode,p)}r(f,"assign",v);export{v as assign,f as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4312458 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.js","../lib/assign.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport isOrder from '@stdlib/ndarray-base-assert-is-order';\nimport isIndexMode from '@stdlib/ndarray-base-assert-is-index-mode';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'mode': 'throw',\n* 'order': 'column-major'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '0jx2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'mode' ) ) {\n\t\topts.mode = options.mode;\n\t\tif ( !isIndexMode( opts.mode ) ) {\n\t\t\treturn new TypeError( format( '0jx5m', 'mode', opts.mode ) );\n\t\t}\n\t}\n\tif ( hasOwnProp( options, 'order' ) ) {\n\t\topts.order = options.order;\n\t\tif ( !isOrder( opts.order ) ) {\n\t\t\treturn new TypeError( format( '0jx5n', 'order', opts.order ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport getSubscripts from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*/\nfunction ind2sub( shape, idx, options ) {\n\tvar opts;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nimport { primitives as isNonNegativeIntegerArray } from '@stdlib/assert-is-nonnegative-integer-array';\nimport { isPrimitive as isInteger } from '@stdlib/assert-is-integer';\nimport shape2strides from '@stdlib/ndarray-base-shape2strides';\nimport { assign as getSubscripts } from '@stdlib/ndarray-base-ind2sub';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Converts a linear index to an array of subscripts and assigns results to a provided output array.\n*\n* ## Notes\n*\n* - The function accepts the following \"modes\":\n*\n* - **throw**: throw an error when a linear index exceeds array dimensions.\n* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions.\n* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic.\n* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index.\n*\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {integer} idx - linear index\n* @param {Options} [options] - function options\n* @param {string} [options.mode=\"throw\"] - specifies how to handle a linear index which exceeds array dimensions\n* @param {string} [options.order=\"row-major\"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style)\n* @param {(Array|TypedArray|Object)} out - output array\n* @throws {TypeError} output argument must be either an array, typed array, or an object\n* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers\n* @throws {TypeError} linear index argument must be integer valued\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {RangeError} must provide a linear index which does not exceed array dimensions\n* @returns {NonNegativeIntegerArray} subscripts\n*\n* @example\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\nfunction ind2sub( shape, idx, options, out ) {\n\tvar opts;\n\tvar dest;\n\tvar err;\n\n\topts = {};\n\topts.mode = defaults.mode;\n\topts.order = defaults.order;\n\tif ( arguments.length === 4 ) {\n\t\terr = validate( opts, arguments[ 2 ] );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\tif ( typeof out !== 'object' || out === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', out ) );\n\t\t}\n\t\tdest = out;\n\t} else {\n\t\tdest = options;\n\t\tif ( typeof dest !== 'object' || dest === null ) {\n\t\t\tthrow new TypeError( format( '0jx5j', dest ) );\n\t\t}\n\t}\n\tif ( !isNonNegativeIntegerArray( shape ) ) {\n\t\tthrow new TypeError( format( '0jx5k', shape ) );\n\t}\n\tif ( !isInteger( idx ) ) {\n\t\tthrow new TypeError( format( '0jx5l', idx ) );\n\t}\n\t// Note: strides are positive, so offset is always zero\n\treturn getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len\n}\n\n\n// EXPORTS //\n\nexport default ind2sub;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Convert a linear index to an array of subscripts.\n*\n* @module @stdlib/ndarray-ind2sub\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var s = ind2sub( [ 3, 3, 3 ], 17 );\n* // returns [ 1, 2, 2 ]\n*\n* @example\n* import ind2sub from '@stdlib/ndarray-ind2sub';\n*\n* var shape = [ 3, 3, 3 ];\n* var out = [ 0, 0, 0 ];\n*\n* var s = ind2sub.assign( shape, 17, out );\n* // returns [ 1, 2, 2 ]\n*\n* var bool = ( s === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["validate","opts","options","isObject","hasOwnProp","mode","isIndexMode","TypeError","format","order","isOrder","ind2sub","shape","idx","err","defaults","arguments","length","isNonNegativeIntegerArray","isInteger","getSubscripts","shape2strides","out","dest","setReadOnly","main","assign"],"mappings":";;mkCAoDA,SAASA,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,UACzBD,EAAKI,KAAOH,EAAQG,MACdC,EAAaL,EAAKI,OAChB,IAAIE,UAAWC,EAAQ,QAAS,OAAQP,EAAKI,OAGjDD,EAAYF,EAAS,WACzBD,EAAKQ,MAAQP,EAAQO,OACfC,EAAST,EAAKQ,QACZ,IAAIF,UAAWC,EAAQ,QAAS,QAASP,EAAKQ,QAGhD,KAdC,IAAIF,UAAWC,EAAQ,QAASN,GAezC,CCRA,SAASS,EAASC,EAAOC,EAAKX,GAC7B,IAAID,EACAa,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACRC,UAAUC,OAAS,IACvBH,EAAMd,EAAUC,EAAMC,IAErB,MAAMY,EAGR,IAAMI,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAC3F,CCbA,SAASM,EAASC,EAAOC,EAAKX,EAASoB,GACtC,IAAIrB,EACAsB,EACAT,EAKJ,IAHAb,EAAO,CAAA,GACFI,KAAOU,EACZd,EAAKQ,MAAQM,EACa,IAArBC,UAAUC,OAAe,CAE7B,GADAH,EAAMd,EAAUC,EAAMe,UAAW,IAEhC,MAAMF,EAEP,GAAoB,iBAARQ,GAA4B,OAARA,EAC/B,MAAM,IAAIf,UAAWC,EAAQ,QAASc,IAEvCC,EAAOD,CACT,MAEE,GAAqB,iBADrBC,EAAOrB,IACmC,OAATqB,EAChC,MAAM,IAAIhB,UAAWC,EAAQ,QAASe,IAGxC,IAAML,EAA2BN,GAChC,MAAM,IAAIL,UAAWC,EAAQ,QAASI,IAEvC,IAAMO,EAAWN,GAChB,MAAM,IAAIN,UAAWC,EAAQ,QAASK,IAGvC,OAAOO,EAAeR,EAAOS,EAAeT,EAAOX,EAAKQ,OAAS,EAAGR,EAAKQ,MAAOI,EAAKZ,EAAKI,KAAMkB,EACjG,CC/CAC,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 5e230fc..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ).assign; -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts and assigns results to a provided output array. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @param {(Array|TypedArray|Object)} out - output array -* @throws {TypeError} output argument must be either an array, typed array, or an object -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === out ); -* // returns true -*/ -function ind2sub( shape, idx, options, out ) { - var opts; - var dest; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length === 4 ) { - err = validate( opts, arguments[ 2 ] ); - if ( err ) { - throw err; - } - if ( typeof out !== 'object' || out === null ) { - throw new TypeError( format( '0jx5j', out ) ); - } - dest = out; - } else { - dest = options; - if ( typeof dest !== 'object' || dest === null ) { - throw new TypeError( format( '0jx5j', dest ) ); - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode, dest ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 59a64b3..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "mode": "throw", - "order": "row-major" -} diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index ae2b193..0000000 --- a/lib/index.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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'; - -/** -* Convert a linear index to an array of subscripts. -* -* @module @stdlib/ndarray-ind2sub -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -* -* @example -* var ind2sub = require( '@stdlib/ndarray-ind2sub' ); -* -* var shape = [ 3, 3, 3 ]; -* var out = [ 0, 0, 0 ]; -* -* var s = ind2sub.assign( shape, 17, out ); -* // returns [ 1, 2, 2 ] -* -* var bool = ( s === 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; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 697ffa9..0000000 --- a/lib/main.js +++ /dev/null @@ -1,88 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isNonNegativeIntegerArray = require( '@stdlib/assert-is-nonnegative-integer-array' ).primitives; -var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive; -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var getSubscripts = require( '@stdlib/ndarray-base-ind2sub' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Converts a linear index to an array of subscripts. -* -* ## Notes -* -* - The function accepts the following "modes": -* -* - **throw**: throw an error when a linear index exceeds array dimensions. -* - **normalize**: normalize negative linear indices and throw an error when a linear index exceeds array dimensions. -* - **wrap**: wrap around a linear index exceeding array dimensions using modulo arithmetic. -* - **clamp**: set a linear index exceeding array dimensions to either `0` (minimum linear index) or the maximum linear index. -* -* @param {NonNegativeIntegerArray} shape - array shape -* @param {integer} idx - linear index -* @param {Options} [options] - function options -* @param {string} [options.mode="throw"] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order="row-major"] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @throws {TypeError} shape argument must be an array-like object containing nonnegative integers -* @throws {TypeError} linear index argument must be integer valued -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {RangeError} must provide a linear index which does not exceed array dimensions -* @returns {NonNegativeIntegerArray} subscripts -* -* @example -* var s = ind2sub( [ 3, 3, 3 ], 17 ); -* // returns [ 1, 2, 2 ] -*/ -function ind2sub( shape, idx, options ) { - var opts; - var err; - - opts = {}; - opts.mode = defaults.mode; - opts.order = defaults.order; - if ( arguments.length > 2 ) { - err = validate( opts, options ); - if ( err ) { - throw err; - } - } - if ( !isNonNegativeIntegerArray( shape ) ) { - throw new TypeError( format( '0jx5k', shape ) ); - } - if ( !isInteger( idx ) ) { - throw new TypeError( format( '0jx5l', idx ) ); - } - // Note: strides are positive, so offset is always zero - return getSubscripts( shape, shape2strides( shape, opts.order ), 0, opts.order, idx, opts.mode ); // eslint-disable-line max-len -} - - -// EXPORTS // - -module.exports = ind2sub; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 2413b4f..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var isOrder = require( '@stdlib/ndarray-base-assert-is-order' ); -var isIndexMode = require( '@stdlib/ndarray-base-assert-is-index-mode' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.mode] - specifies how to handle a linear index which exceeds array dimensions -* @param {string} [options.order] - specifies whether an array is row-major (C-style) or column-major (Fortran-style) -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'mode': 'throw', -* 'order': 'column-major' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '0jx2V', options ) ); - } - if ( hasOwnProp( options, 'mode' ) ) { - opts.mode = options.mode; - if ( !isIndexMode( opts.mode ) ) { - return new TypeError( format( '0jx5m', 'mode', opts.mode ) ); - } - } - if ( hasOwnProp( options, 'order' ) ) { - opts.order = options.order; - if ( !isOrder( opts.order ) ) { - return new TypeError( format( '0jx5n', 'order', opts.order ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 75cb997..c6962f1 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Convert a linear index to an array of subscripts.", "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" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,46 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-integer": "^0.2.3", - "@stdlib/assert-is-nonnegative-integer-array": "^0.2.3", - "@stdlib/assert-is-plain-object": "^0.2.3", - "@stdlib/ndarray-base-assert-is-index-mode": "^0.2.2", - "@stdlib/ndarray-base-assert-is-order": "^0.2.2", - "@stdlib/ndarray-base-ind2sub": "^0.2.3", - "@stdlib/ndarray-base-shape2strides": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-uint8": "^0.2.3", - "@stdlib/assert-is-array": "^0.2.3", - "@stdlib/math-base-special-floor": "^0.2.4", - "@stdlib/ndarray-base-numel": "^0.2.3", - "@stdlib/random-base-randu": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d197cf0 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 23e271f..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,879 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var Uint8Array = require( '@stdlib/array-uint8' ); -var ind2sub = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an output argument which is not an array, typed array, or object (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0 - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, {}, value ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {}, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {}, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts, [ 0, 0, 0 ] ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = [ 0, 0 ]; - s = ind2sub( shape, 0, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 1, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 2, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - out = [ 0, 0 ]; - s = ind2sub( shape, 3, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.strictEqual( out, s, 'returns output array' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; typed array)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 2, 2 ]; - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 0, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 1, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 0, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 2, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 0, 'returns expected value' ); - - out = new Uint8Array( shape.length ); - s = ind2sub( shape, 3, out ); - t.strictEqual( out, s, 'returns output array' ); - t.strictEqual( s[ 0 ], 1, 'returns expected value' ); - t.strictEqual( s[ 1 ], 1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var out; - var s; - - shape = [ 3, 3, 3 ]; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0, 0 ]; - - s = ind2sub( shape, 17, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 0, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.strictEqual( s, out, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts, [ 0, 0 ] ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var out; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - out = [ 0, 0 ]; - - s = ind2sub( shape, 2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts, out ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts, out ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts, out ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts, out ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 00282b7..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2021 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 tape = require( 'tape' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is a method for assigning results to a specified output array', function test( t ) { - t.strictEqual( hasOwnProp( ind2sub, 'assign' ), true, 'has property' ); - t.strictEqual( typeof ind2sub.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 85dac67..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,752 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var ind2sub = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ind2sub, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if not provided an array-like object containing nonnegative integers as the shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1, 2, null ], - [ 1, 2, 3.14 ], - [ 1, 2, NaN ], - [ 1, 2, '3' ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided a linear index argument which is not an integer value (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -0.14, - 0.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], value, {} ); - }; - } -}); - -tape( 'the function throws an error if not provided an object for the options argument', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - ind2sub( [ 3, 3, 3 ], 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var opts = { - 'mode': value - }; - ind2sub( [ 3, 3, 3 ], 0, opts ); - }; - } -}); - -tape( 'the function converts a linear index to an array of subscripts (2d)', function test( t ) { - var shape; - var s; - - shape = [ 2, 2 ]; - - s = ind2sub( shape, 0 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (2d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d)', function test( t ) { - var shape; - var s; - - shape = [ 3, 3, 3 ]; - - s = ind2sub( shape, 17 ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 2, 2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (3d; order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 3, 3, 3 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 17, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 2, 2, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'row-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function converts a linear index to an array of subscripts (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'order': 'column-major' - }; - - s = ind2sub( shape, 0, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 1, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 2, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.strictEqual( isArray( s ), true, 'returns expected value' ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (default)', function test( t ) { - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999 ); - } -}); - -tape( 'if the `mode` is `throw`, the function throws if provided a linear index which exceeds array dimensions (option)', function test( t ) { - var opts = { - 'mode': 'throw' - }; - - t.throws( foo, RangeError, 'throws a range error' ); - t.end(); - - function foo() { - ind2sub( [ 2, 2 ], 999999, opts ); - } -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `wrap`, the function wraps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `clamp`, the function clamps a linear index which exceeds array dimensions (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'clamp', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 4, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 5, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -8, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 13, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -5, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -7, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=row-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'row-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if the `mode` is `normalize`, the function normalize negative linear indices (order=column-major)', function test( t ) { - var shape; - var opts; - var s; - - shape = [ 2, 2 ]; - opts = { - 'mode': 'normalize', - 'order': 'column-major' - }; - - s = ind2sub( shape, 2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - s = ind2sub( shape, 3, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -1, opts ); - t.deepEqual( s, [ 1, 1 ], 'returns expected value' ); - - s = ind2sub( shape, -4, opts ); - t.deepEqual( s, [ 0, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -3, opts ); - t.deepEqual( s, [ 1, 0 ], 'returns expected value' ); - - s = ind2sub( shape, -2, opts ); - t.deepEqual( s, [ 0, 1 ], 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index a7313a1..0000000 --- a/test/test.validate.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2018 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 tape = require( 'tape' ); -var validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an `options` argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - true, - false, - void 0, - null, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `order` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'order': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided an unsupported/unrecognized `mode` option', function test( t ) { - var values; - var opts; - var err; - var i; - - values = [ - '5', - 'beep', - 'boop', - 'foo', - 'bar', - 'throws', - 5, - true, - false, - void 0, - null, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - opts = { - 'mode': values[ i ] - }; - err = validate( {}, opts ); - t.strictEqual( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns `null` if all options are valid', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'mode': 'wrap', - 'order': 'column-major' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns expected value' ); - t.deepEqual( opts, options, 'sets options' ); - - t.end(); -}); - -tape( 'the function will ignore unrecognized options', function test( t ) { - var options; - var opts; - var err; - - opts = {}; - options = { - 'beep': true, - 'boop': 'bop' - }; - - err = validate( opts, options ); - t.strictEqual( err, null, 'returns expected value' ); - t.deepEqual( opts, {}, 'ignores unrecognized options' ); - - t.end(); -}); From 86befb68148f669be7fc7a4d649f2bb223988695 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 19:43:14 +0000 Subject: [PATCH 126/127] Update README.md for ESM bundle v0.2.3 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 31d3db9..bd201b5 100644 --- a/README.md +++ b/README.md @@ -52,13 +52,13 @@ limitations under the License. ## Usage ```javascript -import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; +import ind2sub from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@v0.2.3-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-ind2sub@v0.2.3-esm/index.mjs'; ``` #### ind2sub( shape, idx\[, options] ) @@ -153,7 +153,7 @@ The function accepts the same `options` as above.